OWX
FHEM module to commmunicate with 1-Wire bus devices
- via an active DS2480/DS2482/DS2490/DS9097U bus master interface attached to an
USB port or
- via a passive DS9097 interface attached to an USB port or
- via a network-attached CUNO or through a COC on the RaspBerry Pi
Internally these interfaces are vastly different, read the corresponding Wiki pages
Example
define OWio1 OWX /dev/ttyUSB1
define OWio2 OWX COC
Define
define <name> OWX <serial-device> or
define <name> OWX <cuno/coc-device>
Define a 1-Wire interface to communicate with a 1-Wire bus.
-
<serial-device> The serial device (e.g. USB port) to which
the 1-Wire bus is attached.
-
<cuno-device> The previously defined CUNO to which the 1-Wire
bus is attached.
Set
-
set <name> interval <value>
sets the time period in seconds for "kicking" the 1-Wire bus
(default is 300 seconds). This means:
- With 1-Wire bus interfaces that do not supply power to the 1-Wire bus
(attr buspower parasitic), the 1-Wire bus is reset at these intervals.
- With 1-Wire bus interfaces that supply power to the 1-Wire bus (attr
buspower = real), all temperature measurement devices on the bus receive
the command to start a temperature conversion (saves a lot of time when
reading)
- With 1-Wire bus interfaces that contain a busmaster chip, the response
to a reset pulse contains information about alarms.
-
set <name> followAlarms on|off
instructs the module to start an alarm search in case a reset pulse
discovers any 1-Wire device which has the alarm flag set.
Get
-
get <name> alarms
performs an "alarm search" for devices on the 1-Wire bus and, if
found, generates an event in the log (not with CUNO).
-
get <name> devices
redicovers all devices on the 1-Wire bus. If a device found has a
previous definition, this is automatically used. If a device is found but has no
definition, it is autocreated. If a defined device is not on the 1-Wire bus, it
is autodeleted.
Attributes
OWAD
FHEM module to commmunicate with 1-Wire A/D converters
Note:
This
1-Wire module so far works only with the OWX interface module. Please define an OWX device first.
Example
define OWX_AD OWAD 724610000000 45
attr OWX_AD DAlarm high
attr OWX_AD DFactor 31.907097
attr OWX_AD DHigh 50.0
attr OWX_AD DName relHumidity|humidity
attr OWX_AD DOffset -0.8088
attr OWX_AD DUnit percent|%
Define
define <name> OWAD [<model>] <id> [<interval>]
Define a 1-Wire A/D converter.
-
[<model>]
Defines the A/D converter model (and thus
1-Wire family id), currently the following values are permitted:
- model DS2450 with family id 20 (default if the model parameter is
omitted)
-
<id>
12-character unique ROM id of the converter device without family id and
CRC code
-
<interval>
Measurement interval in seconds. The default is 300 seconds.
Set
Get
Attributes
attr <name> stateAL0
<string>
character string for denoting low normal condition, default is green down
triangle, e.g. the code <span
style="color:green">▾</span> leading to the sign ▾
attr <name> stateAH0
<string>
character string for denoting high alarm condition, default is green
upward triangle, e.g. the code <span
style="color:green">▴</span> leading to the sign ▴
attr <name> stateAL1
<string>
character string for denoting low alarm condition, default is red down
triangle, e.g. the code <span style="color:red">▾</span>
leading to the sign ▾attr <name> stateAH1
<string>
character string for denoting high alarm condition, default is red upward
triangle, e.g. the code <span style="color:red">▴</span>
leading to the sign ▴
For each of the following attributes, the channel identification A,B,C,D may be
used.
OWCOUNT
FHEM module to commmunicate with 1-Wire Counter/RAM DS2423 #
Note:
This 1-Wire module so far works only with the OWX interface module. Please define an OWX device first.
Example
define OWX_C OWCOUNT DS2423 CE780F000000 300
attr OWX_C AName Water|volume
attr OWX_C AUnit liters|l
attr OWX_CAMode daily
Define
define <name> OWCOUNT [<model>] <id>
[<interval>]
Define a 1-Wire counter.
-
[<model>]
Defines the counter model (and thus 1-Wire
family id), currently the following values are permitted:
- model DS2423 with family id 1D (default if the model parameter is
omitted)
-
<id>
12-character unique ROM id of the converter device without family id and
CRC code
-
<interval>
Measurement interval in seconds. The default is 300 seconds.
Set
Get
Attributes
OWID
FHEM module for 1-Wire devices that know only their unique ROM ID
Note:
This 1-Wire module so far works only with the OWX interface module.
Please define an OWX device first.
Example
define ROM1 OWX_ID OWCOUNT CE780F000000
Define
define <name> OWID <id>
Define a 1-Wire device.
-
<id>
12-character unique ROM id of the converter device without family id and
CRC code
Get
OWLCD
FHEM module to commmunicate with the 1-Wire LCD controller
from Louis Swart (1-Wire family id FF). See also the corresponding Wiki page.
Note:
This 1-Wire module so far works only with the OWX interface module. Please
define an OWX device first.
Example
define OWX_LCD OWLCD 9F0700000100
Define
define <name> OWLCD <id>
Define a 1-Wire LCD device.
-
<id>
12-character unique ROM id of the converter device without family id and
CRC code
Set
Get
Attributes
OWMULTI
FHEM module to commmunicate with 1-Wire multi-sensors, currently the DS2438 smart battery monitor
Note:
This
1-Wire module so far works only with the OWX interface module. Please define an OWX device first.
Example
define OWX_M OWMULTI 7C5034010000 45
attr OWX_M VName relHumidity|humidity
attr OWX_M VUnit percent|%
attr OWX_M VFunction (161.29 * V / VDD - 25.8065)/(1.0546 - 0.00216 * T)
Define
define <name> OWMULTI [<model>] <id> [<interval>]
Define a 1-Wire multi-sensor
-
[<model>]
Defines the sensor model (and thus
1-Wire family id), currently the following values are permitted:
- model DS2438 with family id 26 (default if the model parameter is
omitted). Measured is a temperature value, an external voltage and the current supply voltage
-
<id>
12-character unique ROM id of the converter device without family id and
CRC code
-
<interval>
Measurement interval in seconds. The default is 300 seconds.
Set
Get
Attributes
attr <name> VName
<string>|<string>
name for the channel | a type description for the measured value. attr <name> VUnit
<string>|<string>
unit of measurement for this channel | its abbreviation. attr <name> VFunction
<string>
arbitrary functional expression involving the values VDD, V, T. Example see above.
- VDD is replaced by the measured supply voltage in Volt,
- V by the measured external voltage,
- T by the measured and corrected temperature in its unit
attr <name> tempOffset
<float>
temperature offset in °C added to the raw temperature reading. attr <name> tempUnit
Celsius|Kelvin|Fahrenheit|C|K|F
unit of measurement (temperature scale), default is Celsius = °C attr <name> event on-change|on-update
This attribte work similarly, but not identically to the standard event-on-update-change/event-on-update-reading attribute.
event on-update (default) will write a notify/FileLog event any time a measurement is received.event on-change will write a notify/FileLog event only when a measurement is different from the previous one.
- Standard attributes alias, comment, eventMap, loglevel, webCmd
OWSWITCH
FHEM module to commmunicate with 1-Wire Programmable Switches
Note:
This 1-Wire module so far works only with the OWX interface module. Please define an OWX device first.
Example
define OWX_S OWSWITCH DS2413 B5D502000000 60
attr OWX_S AName Lampe|light
attr OWX_S AUnit AN|AUS
Define
define <name> OWSWITCH [<model>] <id>
[<interval>]
Define a 1-Wire switch.
-
[<model>]
Defines the switch model (and thus 1-Wire
family id), currently the following values are permitted:
- model DS2413 with family id 3A (default if the model parameter is
omitted). 2 Channel switch with onboard memory
- model DS2406 with family id 12. 2 Channel switch
- model DS2406 with family id 29. 8 Channel switch
-
<id>
12-character unique ROM id of the converter device without family id and
CRC code
-
<interval>
Measurement interval in seconds. The default is 300 seconds.
Set
Get
-
get <name> id
Returns the full 1-Wire device id OW_FAMILY.ROM_ID.CRC
-
get <name> present
Returns 1 if this 1-Wire device is present, otherwise 0.
-
get <name> interval
Returns measurement interval
in seconds.
-
get <name> input <channel-name>
state for channel (A,B, ... or defined channel name)
This value reflects the measured value, not necessarily the one set as
output state, because the output transistors are open collector switches. A measured
state of 1 = OFF therefore corresponds to an output state of 1 = OFF, but a measured
state of 0 = ON can also be due to an external shortening of the output.
-
get <name> gpio
Obtain state of all
channels
Attributes For each of the following attributes, the channel
identification A,B,... may be used.
OWTHERM
FHEM module to commmunicate with 1-Wire bus digital thermometer devices
Note:
This is the only 1-Wire module which so far works with both the OWFS and the
OWX interface module. Please define an OWFS device or an OWX device first.
Example
define OWX_T OWTHERM DS18B20 E8D09B030000 300
attr OWX_T tempUnit Kelvin
Define
define <name> OWTHERM [<model>] <id>
[<interval>]
Define a 1-Wire digital thermometer device.
-
[<model>]
Defines the thermometer model (and thus
1-Wire family id) currently the following values are permitted:
- model DS1820 with family id 10 (default if the model parameter is
omitted)
- model DS1822 with family id 22
- model DS18B20 with family id 28
-
<id>
12-character unique ROM id of the thermometer device without family id and
CRC code
-
<interval>
Temperature measurement interval in seconds. The default is 300 seconds.
Example:
define Temp1 OWTHERM 14B598010800 300
Set
Get
Attributes
attr <name> stateAL <string>
character string for denoting low alarm condition, default is red down
triangle, e.g. the code <span style="color:red">▾</span>
leading to the sign ▾
attr <name> stateAH <string>
character string for denoting high alarm condition, default is red upward
triangle, e.g. the code <span style="color:red">▴</span>
leading to the sign ▴
attr <name> tempOffset
<float>
temperature offset in °C added to the raw temperature reading. attr <name> tempUnit
Celsius|Kelvin|Fahrenheit|C|K|F
unit of measurement (temperature scale), default is Celsius = °C -
attr <name> tempHigh <float>
high alarm temperature (on the temperature scale chosen by the attribute
value).
-
attr <name> tempLow <float>
low alarm temperature (on the temperature scale chosen by the attribute
value).
attr <name> event on-change|on-update
This attribte work similarly, but not identically to the standard event-on-update-change/event-on-update-reading attribute.
event on-update (default) will write a notify/FileLog event any time a measurement is received.event on-change will write a notify/FileLog event only when a measurement is different from the previous one.
- Standard attributes alias, comment, eventMap, loglevel, webCmd