| compatible hardware version | 1.* |
| firmware version | 1.0 |
| USB port | micro-B |
| Serial port speed | 115200 |
| USB voltage | 5V |
| USB current | 100mA |
If you are not sure how to connect to your device, you can follow this Getting Started page.
> write onMake sure you don't have recorded steps running. This command will interrupt the running recorded steps.
> write offMake sure you don't have recorded steps running. This command will interrupt the running recorded steps.
> write toggleMake sure you don't have recorded steps running. This command will interrupt the running recorded steps.
> read state
> write config.normally=closedIf you connect the relay on COM and NC, then the default normally state of the relay is closed. > write on will keep the relay closed. > write off will activate the relay and open the switch.
> write config.normally=openIf you connect the relay on COM and NO, then the default normally state of the relay is open. > write on will activate the relay and close the switch. > write off will keep the relay open.
> write step.1.state=on
> write step.1.delay=1000
> write step.2.state=off
> write step.2.delay=1000
> write process.end_step=2
> write process.mode=cycle
> write process.runRecord 2 steps. Step 1 turns on the switch for 1s. Step 2 turns off the switch for 1s. Set the end step index of the process to be 2. A process is a sequence of steps to run. Use cyclic run mode. Finally, start to run the process.
> write process.run=falseInterrupt the running steps. The steps will run from start, if you set the step.run to true again.
> write process.run=true
> write process.restart
> write calibration.timer.scale=1.01
> read process.current_indexIf you have recorded steps running, this command shows the index of the current step.
> read process.countdownIf you have recorded steps running, this command shows the delay countdown of the current step in microseconds. If the countdown reaches 0, the next step will start to run.
> read step.[step_index].state
[step_index] should be in the range of [1, 50].
The output data type is bool.
> read step.[step_index].delay
[step_index] should be in the range of [1, 50].
The output data type is uint.
The value range of this property is [1, 2147483647].
> read process.mode
The output data type is enum.The value can be one of {cyclic, once}.
> read process.end_step
The output data type is uint.
The value range of this property is [0, 50].
> read process.run
The output data type is bool.
> read process.current_index
The output data type is uint.
> read process.countdown
The output data type is uint.
> read state
The output data type is bool.
> read calibration.timer.scale
The output data type is float.
The value range of this property is [0.5, 2].
> read config.normally
The output data type is enum.The value can be one of {closed, open}.
> read device.exaberry
The output data type is string.
> read device.documentation
The output data type is string.
> read device.name
The output data type is string.
You can customize the device name by writing to this property.
> read device.systick
The output data type is uint.
The systick is approximately the number of microseconds since power up.
> read device.id
The output data type is hex.
The device ID is unique for each device.
> read device.type_id
The output data type is string.
The type ID is unique for different API and hardware design combination.
> read device.firmware.version
The output data type is string.
> read device.hardware.version
The output data type is string.
> write step.[step_index].state={bool}
[step_index] should be in the range of [1, 50].
The input data type isbool.
The updated value of the step's state will take effect the next time this step is current.
> write step.[step_index].delay={uint}
[step_index] should be in the range of [1, 50].
The input data type isuint.
The value range of this property is [1, 2147483647].
The updated value of the step's delay will take effect the next time this step is current.
> write process.mode={enum}
The input data type isenum.
The value of {enum} should be one of {cyclic, once}.
> write process.end_step={uint}
The input data type isuint.
The value range of this property is [0, 50].
The updated value of end_step will take effect at the process restart or running process step change.
> write process.run={bool}
The input data type isbool.
The default value of process.run is True. > write process.run is equivalent to > write process.run=True
The relay will come back to off state after the process finishes.
> write process.restart={bool}
The input data type isbool.
The default value of process.restart is True. > write process.restart is equivalent to > write process.restart=True
> write state={bool}
The input data type isbool.
Writing to the state property will pause any running process.
> write on={bool}
The input data type isbool.
The default value of on is True. > write on is equivalent to > write on=True
Writing to the on property will pause any running process.
> write off={bool}
The input data type isbool.
The default value of off is True. > write off is equivalent to > write off=True
Writing to the off property will pause any running process.
> write toggle={bool}
The input data type isbool.
The default value of toggle is True. > write toggle is equivalent to > write toggle=True
Writing to the toggle property will pause any running process.
> write calibration.timer.scale={float}
The input data type isfloat.
The value range of this property is [0.5, 2].
> write config.normally={enum}
The input data type isenum.
The value of {enum} should be one of {closed, open}.
Changing the normally property will change the state of the relay immediately.
> write device.name={string}
The input data type isstring.
The length of the {string} should be less than 16.
> write device.restart={bool}
The input data type isbool.
The default value of device.restart is True. > write device.restart is equivalent to > write device.restart=True
| A: | 18mm |
| B: | 64mm |
| C: | 2mm |
| D: | 12mm |
| E: | 2.54mm |
The Firmware flashing page documents the steps for downloading the firmware to the device.
