OneWire_xAP.pm

OneWire_xAP

SYNOPSIS

Documentation on installing/configuring oxc is found in the oxc distribution. oxc now uses digitemp (www.digitemp.com) or one-wire file system (owfs; see - www.owfs.org).

The xAP message convention assumes that the one-wire xAP connector, oxc, is addressed via the target: liming.oxc.house

Each "device" is subaddressed using the convention: :<type>.<name> where <type> can be temp, humid, etc and <name> is a user-definable name specfified in the oxc config.

Declaration:

If declaring via .mht:

  OWX,  liming.oxc.house,   house_owx

Where 'liming.oxc.house' is the xAP source address and 'house_owx' is the object

  # declare the oxc "conduit" object
  $oxc = new OneWire_xAP;

  # create one or more AnalogSensor_Items that will be attached to the OneWire_xAP
  # See additional comments in AnalogSensor_Items for .mht based declaration

  $indoor_temp = new AnalogSensor_Item('indoor-t', 'temp');
  # 'indoor-t' is the device name, 'temp' is the sensor type
  $indoor_humid = new AnalogSensor_Item('indoor-h', 'humid');

  $ocx->add($indoor_temp, $indoor_humid);

Information on using AnalogSensor_Items is contained within its corresponding package documentation

DESCRIPTION

This package provides an interface to one-wire devices via the xAP (www.xapautomation.org) "connector": oxc (www.limings.net/xap/oxc)

INHERITS

Base_Item

METHODS

UnDoc

INI PARAMETERS

NONE

AUTHOR

Gregg Liming gregg@limings.net

SEE ALSO

NONE

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 OneWire_xAP.pm