InfernoEmbedded(3)

1InfernoEmbedded(3)           One-Wire File System           InfernoEmbedded(3)
2
3
4

NAME

6       InfernoEmbedded Softdevices
7              - RGBW Controllers - Switch Masters - Firmware Updater
8

SYNOPSIS

10       Software-implemented  devices based on https://github.com/InfernoEmbed‐
11       ded/onewire-softdevice
12
13       ED  [.]XXXXXXXXXXXX[XX][/[  device   |   version   |   status   |   en‐
14       ter_firmware_update  | address | crc8 | id | locator | r_address | r_id
15       | r_locator | type ]]
16

FAMILY CODE

18       ED
19

GENERIC PROPERTIES

21       These properties are applicable to all Inferno Embedded softdevices.
22
23   device
24       read-only, ascii text
25       The type of InfernoEmbedded Softdevice detected.
26
27   version
28       read-only, integer
29       The version number reported by the device.
30
31   status
32       read-only, integer
33       The 64 bit status register of the device.
34
35   enter_firmware_update
36       write-only, yes-no
37       Write anything to reboot the device into the  bootloader  for  firmware
38       update.  This may also be forced if you have physical access to the de‐
39       vice by shorting SWCLK to ground on  the  device's  programming  header
40       when powering up the device.
41
42

FIRMWARE UPDATER PROPERTIES

44       These properties are available when the device has entered firmware up‐
45       date mode.
46
47
48   firmware_bootloader_size
49       read-only, integer
50       The reserved size for the bootloader.
51
52   firmware_range
53       read-only, ascii text
54       The range of addresses available for the application (0xNNNN-0xNNNN).
55
56   erase_firmware
57       write-only, yes-no
58       Write anything to erase the current application and prepare the  device
59       to accept a new firmware.
60
61   update_firmware
62       write-only, binary data
63       Write  the  binary data for a firmware update here to reprogram the de‐
64       vice after erasing.
65
66   exit_firmware_update
67       write-only, yes-no
68       Write anything to exit firmware update and start the application.
69
70

RGBW CONTROLLER PROPERTIES

72       These controllers control a number of channels of RGBW lights.
73
74   rgbw_all_off
75       write-only, yes-no
76       Write anything to turn off all channels
77
78   rgbw_channels
79       read-only, integer
80       The number of RGBW channels supported by this device.
81
82   rgbw_channelNN
83       read-write, ascii text
84       Set the current value of channel NN, as: RRR,GGG,BBB,WWW,nnn  where:
85         RRR,GGG,BBB,WWW is the red, green, blue values respectively (0-255)
86         nnn is the time to fade from the current colour to the  new  one,  in
87       milliseconds  (0-16M).  On read, this is time remaining for the current
88       fade to complete.
89
90

SWITCH MASTERS

92       These devices have a number of indicator LEDs, switch inputs and  relay
93       outputs. Each are grouped into ports of a certain number of channels.
94
95
96   switch_ports
97       read-only, integer
98       The number of switch ports available.
99
100   switch_channels
101       read-only, integer
102       The number of channels available per switch port.
103
104   switch_refresh_activations
105       write-only, yes-no
106       Write  anything  here to update the values of all switch ports from the
107       device.
108
109   switch_portN
110       read-only, ascii text
111       The last fetched state for the port (use switch_refresh_activations  to
112       fetch  the  state).  Formatted as "channel0,channel1...channelN", where
113       each channel is '0' or '1' depending on whether it is activated.
114
115   set_switch_type
116       write-only, ascii text
117       Sets the type of switch connected to  the  device.  Format  "port,chan‐
118       nel,type" where port and channel are integer IDs, and type is:
119         0 Toggle switch to VCC with pull-downs enabled on the device
120         1 Toggle switch to Gnd with pull-ups enabled on the device
121         2 Momentary switch to VCC with pull-downs enabled on the device
122         3 Momentary switch to Gnd with pull-ups enabled on the device
123
124   led_ports
125       read-only, integer
126       The number of LED ports available.
127
128   led_channels
129       read-only, integer
130       The number of channels available per LED port.
131
132   led_portN
133       read-write, ascii text
134       The  state  for  the port. Formatted as "channel0,channel1...channelN",
135       where each channel is '0' or '1' depending on whether the LED is lit.
136
137   relay_ports
138       read-only, integer
139       The number of relay ports available.
140
141   relay_channels
142       read-only, integer
143       The number of channels available per relay port.
144
145   relay_portN
146       read-write, ascii text
147       The state for the port.  Formatted  as  "channel0,channel1...channelN",
148       where  each channel is '0' or '1' depending on whether the relay is ac‐
149       tivated.
150
151   relay_modeN
152       read-write, ascii text
153       The mode for each relay  on  the  port.  Formatted  as  "channel0,chan‐
154       nel1...channelN", where each channel is one of the following modes:
155         0 Channel operates independently
156         1 Channel operates as a member of an even/odd pair
157       If the channels are operated as pairs, the even numbered relay is acti‐
158       vated when the even numbered channel is turned on, and the odd numbered
159       relay  is  activated  when the even numbered channel is turned off. The
160       odd numbered channel has no effect. This is useful when controlling de‐
161       vices  such  as roller shutters, projector screens and air conditioning
162       dampers, which require one relay to be activated to open,  and  another
163       to close.
164
165   relay_timeoutN
166       read-write, ascii text
167       The  timeout  for  each relay on the port. Formatted as "channel0,chan‐
168       nel1...channelN", where each channel is an integer (0-255) representing
169       the number of seconds the relay will remain activated when operating as
170       an even/odd pair.
171
172

ADDRESSING

174       All 1-wire devices are factory assigned a unique 64-bit  address.  This
175       address is of the form:
176
177       Family Code
178              8 bits
179
180       Address
181              48 bits
182
183       CRC    8 bits
184
185       Addressing under OWFS is in hexadecimal, of form:
186
187              01.123456789ABC
188
189       where 01 is an example 8-bit family code, and 12345678ABC is an example
190       48 bit address.
191
192       The dot is optional, and the CRC code can  included.  If  included,  it
193       must be correct.
194

AVAILABILITY

257       https://github.com/InfernoEmbedded/onewire-softdevice
258

AUTHOR

260       Alastair D'Silva (alastair@d-silva.org)
261
262
263
264OWFS Manpage                         2018                   InfernoEmbedded(3)