Status and utility¶
#Save #Reset #Default #Pullconfig #Info #Tone #Par #Tool #WdFb #Product #Param #Help #Error #Clear #Mode #Vbus #Vmax #Temp #Term #Tlim #Iabc #PWM #LED #CANID #SERNUM #Activate #Cyc #Cyca
#Save¶
Action
Writes the configuration to the EEPROM. Do it after calibration and after tuning.
Response: Save
#Reset¶
Action
Resets the driver. From firmware 104 the reset lands in the bootloader, which waits 2 s for a flashing host and then starts the firmware again.
Response: nothing
#Default¶
Action
Writes the factory defaults to the EEPROM and loads them: the calibration is erased (Not calibrated), the gripper flag, heartbeat and watchdog are cleared, the hardware version and batch date are set to 1 and 24092024, and 1111 is stored as the serial number; from firmware 109 also the tool id (0), the watchdog fallback, and the anti-cogging set, the encoder table, its trims and parameter 56 (cleared). From firmware 109 the CAN node ID is kept (0 only when no valid one is stored). Note the values first.
Response: Loaded default config!
#Pullconfig¶
Get
Prints the whole configuration on one line, for Motor GUI.
Response: the configuration
#Info¶
Action
Prints the driver's identity and the motor: hardware version, batch date, firmware version, ISR time, CAN ID, calibrated or not, temperature, Vbus, Dir, phase order, commutation direction, the speeds of the calibration spin, pole pairs, R, L, Kt and KV. From firmware 109 also the build (Build:, the git commit, with + when built with uncommitted changes), the Board ID (this board, from the chip's unique number; not the bootloader's board ID), the Calibration ID (new at every successful calibration), the CAN receive overruns and dropped transmits, the product, the current-sense zeros, the tool id, the watchdog and its fallback, settings block 2, the anti-cogging, and at the end the In force: section (see Status and diagnostics). The serial number is #SERNUM, the gains #Param, the errors #Error.
Response: the report
#Tone¶
Set/GetArgument f,mA[,ms], or offEnters position mode
A tone through the motor (see Sound): #Tone 440,250,1000 plays 440 Hz at a loudness of 250 mA for 1000 ms, on the axis parameter 82 picks. mA left out: 200; ms left out: 500; ms 0: until #Tone off. 20 Hz up to below 2500 Hz. It plays only while the driver holds or moves; from idle a calibrated driver first holds the position it is at (#Idle releases it). #Tone alone or #Tone off stops all sound. Added in firmware 109.
Response: Tone 440 Hz, 250 mA, 1000 ms; from idle first Holding the position while it plays (#Idle releases it); Tone: not played (…) when it cannot; Tone off
#Par¶
Set/GetArgument int: n, or n,value
Any parameter by its number (see Parameters and buffers): alone it lists every parameter, #Par 1 reads one, #Par 1,200 sets it (no spaces); a gain or limit (8-16, 20) takes a decimal, e.g. #Par 9,0.02 sets Kpv. Added in firmware 109.
Response: P<n> = <value>; refused: out of range, read only, not now, or unknown when the driver did not take it; P<n> unknown
#Tool¶
Set/GetArgument int: 0 to 255
The tool id: what the drive is built into, 0 none, 1 SSG-48, 11-33 MSG (tens = rail 1/2/3 = 100/150/200 mm, units = stepper 1/2/3 = 21.5/40/60 mm), 200-254 your own. The same as parameter 1. Kept by Save. Added in firmware 109.
Response: Tool ID: N, or Invalid tool id (0-255)
#WdFb¶
Set/GetArgument int list: time_ms,current_mA,speed_ticks_s,after_action
The watchdog fallback, four numbers at once without spaces, e.g. #WdFb 2000,0,1000,2: how long hold or descend runs, descend's current and speed cap, and what follows (0 legacy, 2 brake, 3 coast). The same as parameters 2 to 5, clamped the same way; fewer than four numbers change nothing. Kept by Save. Added in firmware 109.
Response: Watchdog fallback: … ms, … mA, … ticks/s, then …
#Product¶
ActionArgument nothing, or claim, clear
The product lock: prints this firmware and the board's stamp. claim stamps the board as this product (a repaired board, a motor the stamp rule misjudges), clear removes the stamp; power-cycle after either. Over UART only. Added in firmware 109.
Response: Firmware: Spectral Micro; board stamp: …
#Param¶
Get
Prints every gain of every loop.
Response: the gains
#Help¶
Action
Prints a short command reference. Added in firmware 106.
Response: the reference
#Error¶
Get
Prints which errors are active.
Response: No errors! or In error state!, then one line per active error (see Errors and LED states), and FAULT pin is LOW: the gate driver reports a fault while the driver stage's fault pin is active
#Clear¶
ActionEnters idle mode
Clears the errors and goes to idle. An error whose cause is still present comes straight back; a calibration error is cleared only by calibrating (or #Calibrated 1).
Response: Clear errors
#Mode¶
Get
Prints the control mode. In voltage-torque mode (#Uq) it prints nothing.
Response: Idle mode, Position control, Speed control, Current control, PD control, Open loop, Gripper mode, Gripper calib mode
#Vbus¶
Get
Prints the supply voltage.
Response: mV
#Vmax¶
Set/GetArgument int: voltage in mV
The supply voltage above which a Vbus error is raised: 29000 mV after #Default.
Response: Vmax in mV: N
#Temp¶
Get
Prints the thermistor temperature.
Response: °C, or Temp Off while the thermistor is disabled
#Term¶
Set/GetArgument int: 0 or 1
Enables the thermistor measurement and the temperature error (off by default). From firmware 110 also parameter 91.
Response: the setting
#Tlim¶
Set/GetArgument int: temperature in °C
The temperature at which the temperature error is raised; 75 by default.
Response: Temp limit N
#Iabc¶
Get
Prints the phase currents.
Response: Ia, Ib, Ic in mA
#PWM¶
Get
Prints the PWM duty values.
Response: the duties
#LED¶
Set/GetArgument int: 0 or 1
Turns the status LED on or off.
Response: the LED state
#CANID¶
Set/GetArgument int: 0 to 13
The CAN node ID. Use 0 to 13: the firmware accepts 14 and 15, but the bootloader reserves them and a driver on one of those cannot be updated over CAN. Kept over a power cycle after Save, which also copies it into the bootloader's board ID; from firmware 109 Default and a settings reset keep it too.
Response: the ID, or Invalid CAN ID
#SERNUM¶
Set/GetArgument int: number
The serial number. Save writes it to the EEPROM, but the firmware does not read it back at power-up: after a power cycle the driver reports 1.
Response: Serial number is: N
#Activate¶
Action
Sets the controller's activated flag (bit 6 of byte 1 of Send_Respond_State_of_Errors). It is not the gripper's activate bit, which #Gripact and Send_gripper_data_pack set.
Response: Controller activated
#Cyc¶
Set/GetArgument int: interval in ms (0 = off)
Sends position, speed and Iq on its own every interval: $ <position> <speed> <Iq>; for BetterSerialPlotter.
Response: Cyclic disabled for #Cyc without a number; #Cyc 0 stops the output without an answer
#Cyca¶
Set/GetArgument int: interval in ms (0 = off)
Like Cyc, in the Arduino plotter format Position:x,Speed:y,Iq:z.
Response: Cyclic disabled for #Cyca without a number; #Cyca 0 stops the output without an answer
Comments
Found a mistake on this page? Edit it on GitHub · Report it · Get help · This page as Markdown · llms.txt · The whole manual as PDF