ASCII Commands

ProffieOS v6.7x009

ASCII Commands

ASCII Commands allow humans access to the inner workings of the operating system. For machine access, see Binary Commands.

Requirements:

• USB / UART connection to a compatible board
• A serial terminal software, such as Arduino's Serial Monitor

Core Commands
Diagnose Commands
Developer Commands

---

Core Commands

Core commands are always active.

Command	Arguments	Answer	Description
help	-	Explicit text	List summary of ASCII commands
reset	-	-	Reset board.
board_info	-	Guarded ASCII*	Reports hardware and firmware description
battery	-	Explicit text	Report battery state.
charger	[ 0 / 850 / 1000 ]	Explicit text	Report charger state. Optionally set charger maximum current, in milliAmps
get_on	-	'0' / '1'	Reports current power state
on	-	-	Power ON
off	-	-	Power OFF
clash	-	-	Trigger CLASH effect
stab	-	-	Trigger STAB effect
force	-	-	Trigger FORCE effect
blast	-	-	Trigger BLAST effect
lock lockup	-	'ON' / 'OFF'	Toggle LOCKUP and report new state
drag	-	'ON' / 'OFF'	Toggle DRAG effect and report new state
lblock lb	-	'ON' / 'OFF'	Toggle LIGHTNING effect and report new state
melt	-	'ON' / 'OFF'	Toggle MELT effect and report new state
stealth	-	-	Toggle Combat / Stealth modes
next preset n pre	-	Explicit text	Change current preset to next in list
prev preset p pre	-	Explicit text	Change current preset to previous in list
list_fonts	-	Guarded ASCII*	Report available sound fonts
list_tracks	-	Guarded ASCII*	Report available sound tracks
list_styles	-	Guarded ASCII*	Report available styles and compatibility flags
list_presets	-	Guarded ASCII*	Report active presets and color variations
list_profile	-	Guarded ASCII*	Report user settings and sensitivities
get_color	-	Guarded ASCII*	Report color variation of current preset
set_color	<value>	-	Change color variation of current preset
get_usersettings	-	Explicit text	Report all user settings
get_usersettings	V / v / B / b / s / p	Guarded ASCII*	Report a single profile setting: V / v = Combat / Stealth volume B / b = Combat / Stealth brightness s = Master sensitivity p = Current preset
set_usersettings	V / v / B / b / s / p , <value>	Explicit text	Change a single profile setting (see get_profile)
get_sensitivity	-	Explicit text	Report all motion sensitivities
get_sensitivity	s / c / b / k / t / w / m	Guarded ASCII*	Report a single motion sensitivity: s = Swing c = Clash b = Stab k = Shake t = Tap w = Twist m = Menu
set_sensitivity	s / c / b / k / t / w / m , <value>	Explicit text	Change a single motion sensitivity (see get_sensitivity)
save_profile	-	Guarded ASCII*	Save user settings, colors and sensitivities in preset.cod
alive	-	Guarded ASCII*	Reports prop and battery state
openSession	-	Explicit text	Open binary session. ASCII commands will no longer be available, until the binary session is closed or the board is reset. See Binary Commands for details.

* Guarded ASCII answers are used for machine interface and follow this format:

<echo>-START
<answer_line1>
<answer_line2>
...
<echo>-END

---

Diagnose Commands

Activation switch: ENABLE_DIAGNOSE_COMMANDS

Command	Arguments	Answer	Description
pwd	-	Font folder	Print working (font) directory
cd	<folder>	-	Change working (font) directory
dir	[ <path>]	Name and size for each file	Reports the content of a folder (working folder if none specified)
cod	<file>	ID, size and handler for each entry	Reports the content of a .COD file
show_current_preset	-	Explicit text	Report current preset
effects	-	Sound files for each effect	Reports the number of sound files found for each effect of the current preset.
tell_style	-	Explicit text	Reports the style(s) of current preset
beep	-	-	Plays 5 beeps
play	<file>	Explicit text	Plays a WAV file from the current font folder
play_track	<file>	Explicit text	Plays a WAV file
stop_track	-	-	Stops playing track sound
get_track	-	File name	Reports track sound currently playing
volumes	-	Audio volumes	Reports audio volume for each WAV player

---

Developer commands

Activation switch: ENABLE_DEVELOPER_COMMANDS

Command	Arguments	Description
dacbuf	-	Print the current contents of the DAC buffer
amp	on / off	Enable / disable amplifier
booster	on / off	Enable / disable voltage booster
dumpwav	<file>	Play a WAV file and report first 64 samples
dumpwavplayer	<index>	Report the status of a WAV player
buffered	-	Reports number of bytes buffered by each WAV player
whatison	-	Report the status of all WAV players
talkie	HEXDATA	Play Talkie
say	bfd / bof / ftl / sd / ...	Test Talkie error messages
talkie12 talkie15		Change Talkie rate
mon[itor]	swings / samples /touch / battery / pwm / clash / temp / serial / fusion	Toggle monitoring of specified activity
dumptrace	-	Report and clear tracing stack. Only active if ENABLE_TRACING is defined.
dumpfusor	-	Report fusor state.
i2cstate	-	Report I2C state.
portstates	-	Report GPIO state.
whatispowered	-	Report active peripherals.
battery_calibration	<mV>	Calibrate battery monitor. Battery voltage must be externally measured and specified as 'mV' = 3500...4000 milliVolts
pow	[ p / r / h / m / l / S / s / L ]	Inject a Power Button event
printRequestedTime	-	Report power manager requests
del	[ <file> ]	Deletes a file

Activation switch: X_PROBECPU

Command	Arguments	Description
top	-	Reports CPU usage
ram	-	Reports RAM usage
malloc	-	Reports dynamic RAM allocation
clk	-	Report CPU clocks
dmamap	-	Report DMA usage

Activation switch: X_MENUTEST (+ active menu)

Command	Arguments	Description
tick	up / dn	Play a tick up / tick down sound
scroll	<strength>	Trigger scroll at specified strength
skip	-	Toggles menu skip (pause navigation) mode
emoji	[ <id>, <loop> ]	[Playes]/Stops an emoji special sound identified by 'id' 'loop' = 0...10000 milliSeconds
voice	[ <id>, <loop> ]	[Playes]/Stops a menu voice identified by 'id' 'loop' = 0...10000 milliSeconds

Activation switch: X_LIGHTTEST

Command	Arguments	Description
ablade	on / off	Turn on/off all analog blades
aled_chtest	<channel>, <R>, <G>, <B>	Set RGB color [0, 255] to analog LED channel number [1, 4]
aled_pintest	<pin>, <brightness>	Set brightness [0, 65535] to analog LED pin number [1, 6]
pblade	on / off	Turn on/off all pixel blades

---

(C) RSX Engineering SRL. FileVer. 1.1 / Dec. 2022