diff --git a/contrib/1-Wire/00_OWX.pm b/contrib/1-Wire/00_OWX.pm index 12c2a5dc9..5dd80e26e 100644 --- a/contrib/1-Wire/00_OWX.pm +++ b/contrib/1-Wire/00_OWX.pm @@ -2,17 +2,17 @@ # # OWX.pm # -# FHEM module to commmunicate directly with 1-Wire bus devices -# via an active DS2480/DS2490/DS9097U bus master interface or -# via a passive DS9097 interface or -# via a network-attached CUNO +# FHEM module to commmunicate with 1-Wire bus devices +# * via an active DS2480/DS2482/DS2490/DS9097U bus master interface attached to an USB port +# * via a passive DS9097 interface attached to an USB port +# * via a network-attached CUNO +# Internally these interfaces are vastly different, read the corresponding Wiki pages +# http://fhemwiki.de/wiki/Interfaces_f%C3%BCr_1-Wire # -# Version 2.0 - June, 2012 +# Version 2.03 - July, 2012 # # Prof. Dr. Peter A. Henning, 2012 # -# Setup interface as: -# # define OWX for USB interfaces or # define OWX for a CUNO interface # @@ -20,7 +20,7 @@ # is a serial (USB) device # is a CUNO device # -# get alarms => find alarmed 1-Wire devices +# get alarms => find alarmed 1-Wire devices (not with CUNO) # get devices => find all 1-Wire devices # # set interval => set period for temperature conversion and alarm testing @@ -382,7 +382,7 @@ sub OWX_Define ($$) { InternalTimer(gettimeofday()+10, "OWX_Discover", $hash,0); #-- Default settings - $hash->{interval} = 60; # kick every minute + $hash->{interval} = 300; # kick every minute $hash->{followAlarms} = "off"; $hash->{ALARMED} = "no"; diff --git a/contrib/1-Wire/21_OWAD.pm b/contrib/1-Wire/21_OWAD.pm index 5fcffbc03..6db7eda78 100644 --- a/contrib/1-Wire/21_OWAD.pm +++ b/contrib/1-Wire/21_OWAD.pm @@ -2,6 +2,10 @@ # # OWAD.pm # +# +# TODO: Alarm limits ergeben "invalid page write attempt" +# +# # FHEM module to commmunicate with 1-Wire A/D converters DS2450 # # Attention: This module may communicate with the OWX module, diff --git a/contrib/1-Wire/21_OWCOUNT.pm b/contrib/1-Wire/21_OWCOUNT.pm index 82fac6653..e0c03c4f5 100644 --- a/contrib/1-Wire/21_OWCOUNT.pm +++ b/contrib/1-Wire/21_OWCOUNT.pm @@ -18,7 +18,7 @@ # # Prof. Dr. Peter A. Henning, 2012 # -# Version 2.0 - June, 2012 +# Version 2.01 - July, 2012 # # Setup bus device in fhem.cfg as # @@ -32,13 +32,17 @@ # without Family ID, e.g. A2D90D000800 # [interval] is an optional query interval in seconds # -# get id => FAM_ID.ROM_ID.CRC -# get present => 1 if device present, 0 if not -# get interval => query interval -# get counter => value for counter -# get counters => values for counters +# get id => FAM_ID.ROM_ID.CRC +# get present => 1 if device present, 0 if not +# get interval => query interval +# get memory => 32 byte string from page 0..13 +# get midnight => todays starting value for counter +# get counter => value for counter +# get counters => values for both counters # -# set interval => set period for measurement +# set interval => set query interval for measurement +# set memory => 32 byte string into page 0..13 +# set midnight => todays starting value for counter # # Additional attributes are defined in fhem.cfg, in some cases per channel, where =A,B # Note: attributes are read only during initialization procedure - later changes are not used. diff --git a/contrib/1-Wire/21_OWLCD.pm b/contrib/1-Wire/21_OWLCD.pm index 6babd7235..810aae593 100644 --- a/contrib/1-Wire/21_OWLCD.pm +++ b/contrib/1-Wire/21_OWLCD.pm @@ -12,7 +12,7 @@ # # Prof. Dr. Peter A. Henning, 2012 # -# Version 2.01 - June, 2012 +# Version 2.03 - July, 2012 # # Setup bus device in fhem.cfg as # @@ -30,6 +30,7 @@ # get version => firmware version of the LCD adapter # get memory => get one of the internal memory pages 0..6 # +# set alert red|yellow|beep|none => set one of the alert states (gpio pins) # set icon on|off|blink => set one of the icons 0..14 # set icon 15 0..6 => set icon no. 15 in one of its values # set line => set one of the display lines 0..3 diff --git a/contrib/1-Wire/21_OWSWITCH.pm b/contrib/1-Wire/21_OWSWITCH.pm index 8b374b23f..734f777c6 100644 --- a/contrib/1-Wire/21_OWSWITCH.pm +++ b/contrib/1-Wire/21_OWSWITCH.pm @@ -16,7 +16,7 @@ # # Prof. Dr. Peter A. Henning, 2012 # -# Version 2.0 - June, 2012 +# Version 2.03 - July, 2012 # # Setup bus device in fhem.cfg as # @@ -37,8 +37,8 @@ # get gpio => values for channels # # set interval => set period for measurement -# set output |ON|OFF => set value for channel (name A, B or defined channel name) -# set gpio value => set values for channels (0 = both OFF, 1 = A ON 2 = B ON 3 = both ON) +# set output ON|OFF => set value for channel (name A, B or defined channel name) +# set gpio value => set values for channels (3 = both OFF, 1 = B ON 2 = A ON 0 = both ON) # # Additional attributes are defined in fhem.cfg, in some cases per channel, where =A,B # Note: attributes are read only during initialization procedure - later changes are not used. diff --git a/contrib/1-Wire/21_OWTEMP.pm b/contrib/1-Wire/21_OWTEMP.pm index 903f44bf0..5cab581af 100644 --- a/contrib/1-Wire/21_OWTEMP.pm +++ b/contrib/1-Wire/21_OWTEMP.pm @@ -6,7 +6,7 @@ # # Attention: This module may communicate with the OWX module, # and also with the 1-Wire File System OWFS - +# # Prefixes for subroutines of this module: # OW = General 1-Wire routines (Martin Fischer, Peter Henning) # OWFS = 1-Wire file system (Martin Fischer) diff --git a/contrib/1-Wire/commandref.html b/contrib/1-Wire/commandref.html new file mode 100755 index 000000000..889420064 --- /dev/null +++ b/contrib/1-Wire/commandref.html @@ -0,0 +1,647 @@ + + + + + + +

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
      • +
    Internally these interfaces are vastly different, read the corresponding Wiki pages +
    +
    + Example
    +
      + define OWio OWX /dev/ttyUSB1 +
      +
    +
    + + Define +
      + define <name> OWX <serial-device> or
      + define <name> OWX <cuno-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">&#x25BE;</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">&#x25B4;</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">&#x25BE;</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">&#x25B4;</span> + leading to the sign ▴ +
      • +
    For each of the following attributes, the channel identification A,B,C,D may be + used. +
+ + +

OWCOUNT

+ + + +

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

+ + + +

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)
        • +
      +
      • +
    • + <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 For each of the following attributes, the channel + identification A,B may be used. +
+ + +

OWTEMP

+
    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 OWTEMP DS18B20 E8D09B030000 300 +
      + attr OWX_T tempUnit Kelvin +
      +

    + + Define +
      + define <name> OWTEMP [<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 OWTEMP 14B598010800 300
      +
    +
    + + Set + +
    + + Get + +
    + + Attributes + +
+ + +
+ +