farmbot v6.0.1-alpha Farmbot.Firmware.Handler behaviour View Source
Any module that implements this behaviour should be a GenStage.
The implementng stage should communicate with the various Farmbot
hardware such as motors and encoders. The Farmbot.Firmware
module
will subscribe_to: the implementing handler. Events should be
Gcodes as parsed by Farmbot.Firmware.Gcode.Parser
.
Link to this section Summary
Callbacks
Calibrate an axis
Lock the firmware
Unlock the firmware
Find home on an axis
Move to a position
Read a paramater
Read a pin
Start a firmware handler
Update a paramater
Write a pin
Manually set an axis’s current position to zero
Link to this section Types
Pin
Mode of a pin.
Link to this section Callbacks
Calibrate an axis.
Lock the firmware.
Unlock the firmware.
Find home on an axis.
move_absolute(handler, vec3) :: fw_ret_val
Move to a position.
Read a paramater.
Read a pin.
Start a firmware handler.
update_param(handler, fw_param, number) :: fw_ret_val
Update a paramater.
write_pin(handler, pin, pin_mode, number) :: fw_ret_val
Write a pin.
Manually set an axis’s current position to zero.