CLP Commands AOS Firmware - OUWECAD/MOWE GitHub Wiki

Command Use Description Shortcut Status Example
help help List available commands. - Ready "help"
info info List information about this array. - Under development "info"
status status #XXX Get module #XXX (ID/alias/me) status. - Ready "status me"
name name #XXX CoolName Assign the alias name CoolName to module #XXX. - Ready "name #002 Sooner"
ping ping #XXX Ping module #XXX (ID/alias/me/all). p Ready "ping all"
sample sample #XXX Read one sample from receiver #XXX (ID/alias/me/all). s Ready "sample Sooner"
stream stream #XXX PortX PortY Inter-module streaming in module #XXX (ID/alias/me) from PortX to PortY. If PortY is not mentioned, then PortX is streamed in/out the front-end. - Ready "stream me p2 p5"
stream #XXX #YYY Intra-module streaming from module #XXX to module #YYY. - Ready "stream me #002"
read read #XXX rate port --noled Read data from receiver #XXX (ID/alias/me/all) into port using the rate sample rate. The indicator LED is toggled at each sample. Use --noled to turn it off. r Ready "read all 10 p1 --noled"
write write #XXX rate port --noled Write data to transmitter #XXX (ID/alias/me/all) from port using the rate sample rate. The indicator LED is toggled at each sample. Use --noled to turn it off. w Ready "write Sooner 60 p1"
on on #XXX Turn transmitter #XXX (ID/alias/me/all) on. - Ready "on me"
off off #XXX Turn transmitter #XXX (ID/alias/me/all) off. - Ready "off #006"
toggle toggle #XXX Toggle transmitter #XXX (ID/alias/me/all). t Ready "toggle Sooner"
pulse pulse #XXX width Output a single pulse on transmitter #XXX (ID/alias/me/all) with pulse width width in ms. - Ready "pulse all 500"
pwm pwm #XXX period width Output a PWM single pulse on transmitter #XXX (ID/alias/me/all) with period and width in micro seconds. - Ready "pwm me 500 300"
stop stop #XXX (pwm) Stop a stream/read/write process to/from module #XXX (ID/alias/me/all). Use pwm to stop a transmitter PWM output. - Under development "stop #001"
pause pause #XXX Pause a stream/read/write process to/from module #XXX (ID/alias/me/all). - Under development "pause Sooner"
resume resume #XXX Resume a stream/read/write process to/from module #XXX (ID/alias/me/all). - Under development "resume all"
zerolevel set zerolevel #XXX level\n\r Set the detector threshold for zeros in receiver #XXX (ID/alias/me/all) to the level in ADC units. - Ready "set zerolevel me 20"
onelevel set onelevel #XXX level Set the detector threshold for ones in receiver #XXX (ID/alias/me/all) to the level in ADC units. - Ready "set onelevel #012 1800"
reset reset #XXX Reset module #XXX (ID/alias/me/all). - Ready "reset Sooner"
update update #XXX Force module #XXX (ID/alias/me) into bootloader mode for firmware upgrade. u Ready "update all"
route route #XXX #YYY Calculate the shortest route between two modules using Dijkstra's algorithm (source, destination). - Ready "route #001 Sooner"
pdmode set pdmode #XXX analog/digital Set the photodiode mode in receiver #XXX (ID/alias/me/all) to analog or digital. This applies to sampling and reading commands. Digital values will use the onelevel and zerolevel parameters. - Ready "set pdmode me digital"
ledmode set ledmode #XXX analog/digital binary/ascii 8/16 Set the front-end LED mode in transmitter #XXX (ID/alias/me/all) to output zeros and ones from the incoming stream directly (digital) or digitize the incoming stream using the onelevel and zerolevel parameters (analog). The stream is read as binary or ascii data and each sample is 8 or 16 bits. - Ready "set ledmode all analog binary 8"
com com long/short Setup commands format long or short. - Ready "com long"