Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

The Ekdahl FAR - Command reference: Difference between revisions

From KNAS Wiki
No edit summary
No edit summary
Line 60: Line 60:
|[variable number (0-9)]:[value (float)]
|[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.
|Sets or returns the user variable defined in the first ''parameter,'' if used to set the variable, the second ''parameter'' is the value.
|-
|expressionparserevaluate
|epev
|[expression]
|Evaluates the given ''expression'' and returns the calculated value. Used for debugging
|-
|testadclatency
|tal
|[value (0 - 65535)]
|Debugging command to test ADC latency
|-
|testadclatencyreturn
|talr
|none
|Stops ADC latency testing started with ''tal''
|-
|testadcminmac
|tamm
|[channel]
|Debugging command to test the min/max value for a given ''channel''
|}
MIDI commands
{| class="wikitable"
|+
!Long name
!Short name
!Parameters
!Description
|-
|-
|midiconfiguration
|midiconfiguration
Line 105: Line 135:
|<nowiki>[conditional (0|1)]</nowiki>
|<nowiki>[conditional (0|1)]</nowiki>
|Clears the entire ''MIDI'' buffer of notes held and turns off any bowing
|Clears the entire ''MIDI'' buffer of notes held and turns off any bowing
|}
ADC / Control box commands
{| class="wikitable"
|+
!Long name
!Short name
!Parameters
!Description
|-
|-
|adccommandmap
|adccommandmap
Line 125: Line 165:
|[channel]:[averages]:[interrupterrorthreshold]:[continuouserrorthreshold]:[continuoustimeout]
|[channel]:[averages]:[interrupterrorthreshold]:[continuouserrorthreshold]:[continuoustimeout]
|Sets the settings for the ''averager'' used for the given ''Control box analog-to-digital channel''. ''Averages'' denote number of values read and averaged, ''interrupterrorthreshold'' sets the value change required for the ''Control box'' to report a new value. The ''continuouserrorthreshold'' and ''continuoustimeout'' are used to allow for ''continuous'' changes. See the ''firmware'' for more information
|Sets the settings for the ''averager'' used for the given ''Control box analog-to-digital channel''. ''Averages'' denote number of values read and averaged, ''interrupterrorthreshold'' sets the value change required for the ''Control box'' to report a new value. The ''continuouserrorthreshold'' and ''continuoustimeout'' are used to allow for ''continuous'' changes. See the ''firmware'' for more information
|-
|expressionparserevaluate
|epev
|[expression]
|Evaluates the given ''expression'' and returns the calculated value. Used for debugging
|-
|testadclatency
|tal
|[value (0 - 65535)]
|Debugging command to test ADC latency
|-
|testadclatencyreturn
|talr
|none
|Stops ADC latency testing started with ''tal''
|-
|testadcminmac
|tamm
|[channel]
|Debugging command to test the min/max value for a given ''channel''
|}
|}
MIDI commands
The ''local'' commands as of this writing (2025-01-26) are:
The ''local'' commands as of this writing (2025-01-26) are:
{| class="wikitable"
{| class="wikitable"
|+
|+
Line 248: Line 272:
|<nowiki>[mode (0|1)]</nowiki>
|<nowiki>[mode (0|1)]</nowiki>
|Sets the ''speed mode'' where ''0 = Automatic'' and ''1 = Manual''. The only difference in between these two modes is that ''Automatic'' will automatically turn off the motor when the bow has been set in its ''rest position'' and no frequency changing ''commands'' have been sent within the time period given by ''bowmotortimeout''
|Sets the ''speed mode'' where ''0 = Automatic'' and ''1 = Manual''. The only difference in between these two modes is that ''Automatic'' will automatically turn off the motor when the bow has been set in its ''rest position'' and no frequency changing ''commands'' have been sent within the time period given by ''bowmotortimeout''
|}
Commands for controlling harmonic series
{| class="wikitable"
|+
!Long name
!Short name
!Parameters
!Description
|-
|-
|bowharmonicseries
|bowharmonicseries
Line 283: Line 317:
|[series]
|[series]
|Removes the ''harmonic series'' given in the ''parameter''. Shifts all ''series''' with a higher ''series'' number
|Removes the ''harmonic series'' given in the ''parameter''. Shifts all ''series''' with a higher ''series'' number
|}
Various
{| class="wikitable"
|+
!Long name
!Short name
!Parameters
!Description
|-
|-
|bowstatus
|bowstatus
Line 328: Line 372:
|none
|none
|Performs a ''pressure calibration''
|Performs a ''pressure calibration''
|-
|nooperation
|nop
|none
|Do absolutely, positively, nothing
|}
Commands relating to the bowing motor
{| class="wikitable"
|+
!Long name
!Short name
!Parameters
!Description
|-
|-
|bowmotorrun
|bowmotorrun
Line 388: Line 447:
|[command string]
|[command string]
|Sets the ''commands'' to execute when the ''bowing motor'' is over the power limit, <u>used to safeguard the motor, '''can ruin the instrument if improperly set'''</u>
|Sets the ''commands'' to execute when the ''bowing motor'' is over the power limit, <u>used to safeguard the motor, '''can ruin the instrument if improperly set'''</u>
|}
Commands for controlling bow pressure
{| class="wikitable"
|+
!Long name
!Short name
!Parameters
!Description
|-
|-
|bowpressurebaseline
|bowpressurebaseline
Line 438: Line 507:
|<nowiki>[(0|1)]</nowiki>
|<nowiki>[(0|1)]</nowiki>
|Sets ''bow hold'' off or on. If ''bow hold'' is on, any ''bowpressurerest''-command will be ignored until ''bowpressurehold'' is set to off. Analog to the concept of ''infinite sustain''
|Sets ''bow hold'' off or on. If ''bow hold'' is on, any ''bowpressurerest''-command will be ignored until ''bowpressurehold'' is set to off. Analog to the concept of ''infinite sustain''
|}
Commands for solenoid control
{| class="wikitable"
|+
!Long name
!Short name
!Parameters
!Description
|-
|-
|solenoid
|solenoid
Line 473: Line 552:
|[duration (0 - 65535)]
|[duration (0 - 65535)]
|Sets the duration of the ''solenoid engagement'' in ɥS. if a value of ''0'' is set the ''solenoid'' will not disengage until a ''solenoiddisengage-''command has been given. This latter behavior is <u>not encouraged</u> as it <u>'''can ruin the instrument if improperly used'''</u>
|Sets the duration of the ''solenoid engagement'' in ɥS. if a value of ''0'' is set the ''solenoid'' will not disengage until a ''solenoiddisengage-''command has been given. This latter behavior is <u>not encouraged</u> as it <u>'''can ruin the instrument if improperly used'''</u>
|}
Commands for controlling the mute
{| class="wikitable"
|+
!Long name
!Short name
!Parameters
!Description
|-
|-
|mutesetposition
|mutesetposition
Line 543: Line 632:
|none
|none
|Runs the ''mute calibration''
|Runs the ''mute calibration''
|}
Commands for bow actuators
{| class="wikitable"
|+
!Long name
!Short name
!Parameters
!Description
|-
|-
|<s>bowactuatoradd</s>
|<s>bowactuatoradd</s>
Line 583: Line 682:
|id
|id
|Sets the ''id'' of the ''current actuator''
|Sets the ''id'' of the ''current actuator''
|-
|nooperation
|nop
|none
|Do absolutely, positively, nothing
|}
|}
Please note that ''commands'' may be added or subtracted from this list as the Ekdahl FAR ''firmware'' development progresses, the most sincere attempts will be made to keep this list up to date but no guarantees will be made.{{docnav
Please note that ''commands'' may be added or subtracted from this list as the Ekdahl FAR ''firmware'' development progresses, the most sincere attempts will be made to keep this list up to date but no guarantees will be made.{{docnav