InfernoEmbedded(3)

NAME

InfernoEmbedded Softdevices
    - RGBW Controllers - Switch Masters - Firmware Updater

SYNOPSIS
Software-implemented devices based on https://github.com/InfernoEmbedded/onewire-softdevice

ED [.]XXXXXXXXXXXX[XX][/[ device | version | status | enter_firmware_update | ]]

FAMILY CODE

ED

GENERIC PROPERTIES
These properties are applicable to all Inferno Embedded softdevices.

  device
read-only, ascii text
The type of InfernoEmbedded Softdevice detected.

  version
read-only, integer
The version number reported by the device.

  status
read-only, integer
The 64 bit status register of the device.

  enter_firmware_update
write-only, yes-no
Write anything to reboot the device into the bootloader for firmware update. This may also be forced if you have physical access to the device by shorting SWCLK to ground on the device's programming header when powering up the device.

FIRMWARE UPDATER PROPERTIES
These properties are available when the device has entered firmware update mode.

  firmware_bootloader_size
read-only, integer
The reserved size for the bootloader.

  firmware_range
read-only, ascii text
The range of addresses available for the application (0xNNNN-0xNNNN).

  erase_firmware
write-only, yes-no
Write anything to erase the current application and prepare the device to accept a new firmware.

  update_firmware
write-only, binary data
Write the binary data for a firmware update here to reprogram the device after erasing.

  exit_firmware_update
write-only, yes-no
Write anything to exit firmware update and start the application.

RGBW CONTROLLER PROPERTIES
These controllers control a number of channels of RGBW lights.

  rgbw_all_off
write-only, yes-no
Write anything to turn off all channels

  rgbw_channels
read-only, integer
The number of RGBW channels supported by this device.

  rgbw_channelNN
read-write, ascii text
Set the current value of channel NN, as: RRR,GGG,BBB,WWW,nnn where:
  RRR,GGG,BBB,WWW is the red, green, blue values respectively (0-255)
  nnn is the time to fade from the current colour to the new one, in milliseconds (0-16M). On read, this is time remaining for the current fade to complete.

SWITCH MASTERS
These devices have a number of indicator LEDs, switch inputs and relay outputs. Each are grouped into ports of a certain number of channels.

  switch_ports
read-only, integer
The number of switch ports available.

  switch_channels
read-only, integer
The number of channels available per switch port.

  switch_refresh_activations
write-only, yes-no
Write anything here to update the values of all switch ports from the device.

  switch_portN
read-only, ascii text
The last fetched state for the port (use switch_refresh_activations to fetch the state). Formatted as "channel0,channel1...channelN", where each channel is '0' or '1' depending on whether it is activated.

  set_switch_type
write-only, ascii text
Sets the type of switch connected to the device. Format "port,channel,type" where port and channel are integer IDs, and type is:
  0 Toggle switch to VCC with pull-downs enabled on the device
  1 Toggle switch to Gnd with pull-ups enabled on the device
  2 Momentary switch to VCC with pull-downs enabled on the device
  3 Momentary switch to Gnd with pull-ups enabled on the device

  led_ports
read-only, integer
The number of LED ports available.

  led_channels
read-only, integer
The number of channels available per LED port.

  led_portN
read-write, ascii text
The state for the port. Formatted as "channel0,channel1...channelN", where each channel is '0' or '1' depending on whether the LED is lit.

  relay_ports
read-only, integer
The number of relay ports available.

  relay_channels
read-only, integer
The number of channels available per relay port.

  relay_portN
read-write, ascii text
The state for the port. Formatted as "channel0,channel1...channelN", where each channel is '0' or '1' depending on whether the relay is activated.

  relay_modeN
read-write, ascii text
The mode for each relay on the port. Formatted as "channel0,channel1...channelN", where each channel is one of the following modes:
  0 Channel operates independently
  1 Channel operates as a member of an even/odd pair
If the channels are operated as pairs, the even numbered relay is activated when the even numbered channel is turned on, and the odd numbered relay is activated when the even numbered channel is turned off. The odd numbered channel has no effect. This is useful when controlling devices such as roller shutters, projector screens and air conditioning dampers, which require one relay to be activated to open, and another to close.

  relay_timeoutN
read-write, ascii text
The timeout for each relay on the port. Formatted as "channel0,channel1...channelN", where each channel is an integer (0-255) representing the number of seconds the relay will remain activated when operating as an even/odd pair.

ADDRESSING

SEE ALSO

AVAILABILITY
https://github.com/InfernoEmbedded/onewire-softdevice

AUTHOR
Alastair D'Silva (alastair@d-silva.org)