Commands - Linux API
Jump to navigation
Jump to search
To formalize documentation of coding please use the following guidelines when creating/editing code:
Commands[edit | edit source]
| Item | Code | Usage |
|---|---|---|
| Command | *c=
|
Actual Command |
| Category | *t=
|
Category of Command |
| Description | *d=
|
Description of Command |
| Required Parameter | [pr1]
|
Any Required Parameter |
| Optional Parameter | <po1>
|
Any Optional Parameter |
| Response | *r1=
|
prefix of pr or po as needed
|
| See Also | *sa=
|
Related Commands |
Possible Categories[edit | edit source]
| Categories |
|---|
| I/O |
| Info |
| RFID |
| RFID (HF) Reader Module |
| RFID (UHF) Reader Module |
| Session |
| System |
| Trigger Mode |
Example[edit | edit source]
The following code:
*c=SET EXAMPLECOMMAND
*t=Example
*d=This is a detailed description of the command.
*[pr1]=time
*prv1.1=100
*prv1.2=150
*prr1=Example Set
*<po1>=delay
*pov1=200
*por1=Example Changed
*sa=GET EXAMPLECOMMAND
would populate this Example Command page.