InfernoEmbedded(3) One-Wire File System InfernoEmbedded(3) NAME InfernoEmbedded Softdevices - RGBW Controllers - Switch Masters - Firmware Updater SYNOPSIS Software-implemented devices based on https://github.com/InfernoEmbed- ded/onewire-softdevice ED [.]XXXXXXXXXXXX[XX][/[ device | version | status | enter_firmware_update | address | crc8 | id | locator | r_address | r_id | r_locator | type ]] 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 up- date. 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 mil- liseconds (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 out- puts. 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 de- vice. 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,chan- nel1...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 re- quire 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,chan- nel1...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 All 1-wire devices are factory assigned a unique 64-bit address. This ad- dress is of the form: Family Code 8 bits Address 48 bits CRC 8 bits Addressing under OWFS is in hexadecimal, of form: 01.123456789ABC where 01 is an example 8-bit family code, and 12345678ABC is an example 48 bit address. The dot is optional, and the CRC code can included. If included, it must be correct. SEE ALSO Programs owfs (1) owhttpd (1) owftpd (1) owserver (1) owdir (1) owread (1) owwrite (1) owpresent (1) owtap (1) Configuration and testing owfs (5) owtap (1) owmon (1) Language bindings owtcl (3) owperl (3) owcapi (3) Clocks DS1427 (3) DS1904 (3) DS1994 (3) DS2404 (3) DS2404S (3) DS2415 (3) DS2417 (3) ID DS2401 (3) DS2411 (3) DS1990A (3) Memory DS1982 (3) DS1985 (3) DS1986 (3) DS1991 (3) DS1992 (3) DS1993 (3) DS1995 (3) DS1996 (3) DS2430A (3) DS2431 (3) DS2433 (3) DS2502 (3) DS2506 (3) DS28E04 (3) DS28EC20 (3) Switches DS2405 (3) DS2406 (3) DS2408 (3) DS2409 (3) DS2413 (3) DS28EA00 (3) Infer- noEmbedded (3) Temperature DS1822 (3) DS1825 (3) DS1820 (3) DS18B20 (3) DS18S20 (3) DS1920 (3) DS1921 (3) DS1821 (3) DS28EA00 (3) DS28E04 (3) EDS0064 (3) EDS0065 (3) EDS0066 (3) EDS0067 (3) EDS0068 (3) EDS0071 (3) EDS0072 (3) MAX31826 (3) Humidity DS1922 (3) DS2438 (3) EDS0065 (3) EDS0068 (3) Voltage DS2450 (3) Resistance DS2890 (3) Multifunction (current, voltage, temperature) DS2436 (3) DS2437 (3) DS2438 (3) DS2751 (3) DS2755 (3) DS2756 (3) DS2760 (3) DS2770 (3) DS2780 (3) DS2781 (3) DS2788 (3) DS2784 (3) Counter DS2423 (3) LCD Screen LCD (3) DS2408 (3) Crypto DS1977 (3) Pressure DS2406 (3) TAI8570 (3) EDS0066 (3) EDS0068 (3) Moisture EEEF (3) DS2438 (3) AVAILABILITY https://github.com/InfernoEmbedded/onewire-softdevice AUTHOR Alastair D'Silva (alastair@d-silva.org) OWFS Manpage 2018 InfernoEmbedded(3)
NAME | SYNOPSIS | FAMILY CODE | GENERIC PROPERTIES | FIRMWARE UPDATER PROPERTIES | RGBW CONTROLLER PROPERTIES | SWITCH MASTERS | ADDRESSING | SEE ALSO | AVAILABILITY | AUTHOR
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=InfernoEmbedded&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>