More actions
Created page with "{{docnav |Command language |Specifications }}" |
No edit summary |
||
| Line 1: | Line 1: | ||
== Introduction == | |||
The ''commands'' in the Ekdahl FAR are using a certain ''naming convention'' to make it more clear which parts of the instrument a certain ''command'' is dealing with. Furthermore commands can be global or local, global commands change settings that will affect the entire instrument, local commands change settings depending on previously set commands. The idea of local commands is a future-proofing of the Ekdahl FAR firmware and can generally be ignored for the time being. The first part of many ''command''-names are a prefix that denotes category, the ''global'' categories as of this writing (2025-01-26) are: | |||
* ''global*'' - commands that have a global reach | |||
* ''midi*'' - commands that deal with ''MIDI'' | |||
* ''adc*'' - commands that deal with the ''Control box'' and its ''analog-to-digital converter'' | |||
* ''expressionparser'' - commands that deal with how ''commands'' are interpreted and parsed, mainly used for debugging | |||
* ''test''* - commands made for testing and debugging | |||
The ''global'' commands as of this writing (2025-01-26) are: | |||
{| class="wikitable" | |||
|+ | |||
!Long name | |||
!Short name | |||
!Parameters | |||
!Description | |||
|- | |||
|requestinfo | |||
|rqi | |||
|[command]:[optional parameters] | |||
|Uses a ''command''-name to retrieve rather than set information associated with it, some commands have no information associated and will return nothing. Some commands require the use of optional ''parameters'' to specify which information that is to be retrieved. | |||
|- | |||
|module | |||
|m | |||
|[module number] | |||
|Sets the current ''module''. This command is intended for future versions of the Ekdahl FAR that may have more than one ''string module.'' Currently '0' is the only valid ''parameter'' | |||
|- | |||
|modulecount | |||
|mc | |||
|none | |||
|Returns the number of ''modules'' in the Ekdahl FAR. Currently always returns '1' | |||
|- | |||
|debugprint | |||
|dp | |||
|<nowiki>[command|usb|hardware|undefined|priority|error|inforequest|expressionparser|debug]:[0|1]</nowiki> | |||
|Used to turn on or off whether the instrument will return certain information over ''USB-Serial''. The first ''parameter'' is the category, the second ''parameter'' is a boolean value. | |||
|- | |||
|version | |||
|ver | |||
|none | |||
|Returns the current ''firmware'' version | |||
|- | |||
|globalsaveallparameters | |||
|gsap | |||
|none | |||
|Saves all current data into the internal flash memory | |||
|- | |||
|globalloadallparameters | |||
|glap | |||
|none | |||
|Loads all data saved into flash, effectively overwriting any changed parameters included in the last save | |||
|- | |||
|globalresetparameters | |||
|grap | |||
|none | |||
|Resets all saved data in the flash memory, requires a immediate reset to be enacted | |||
|- | |||
|globaluservariable | |||
|guv | |||
|[variable number (0-9)]:[value (float)] | |||
|Sets or returns the user variable defined in the first ''parameter,'' if used to set the variable, the second ''parameter'' is the value. | |||
|} | |||
{{docnav | {{docnav | ||
|[[The Ekdahl FAR - Command langue|Command language]] | |[[The Ekdahl FAR - Command langue|Command language]] | ||
|[[The Ekdahl FAR - Specifications|Specifications]] | |[[The Ekdahl FAR - Specifications|Specifications]] | ||
}} | }} | ||