********************
XBee XBR
********************

.. index:: devices; xbee; wall router

Overview
====================

XBee wall router is a small extender used to create or expand a ZigBee
network. Apart from expanding the range and adding redundancy to a
wireless network, it contains a light and a temperature sensor that can be
used for general purposes.

This Dia driver manages an XBee wall router device (L/T) into the Dia
framework.

Configuration
====================

A typical XBee wall router configuration block looks like this::

    - name: xbr0
      driver: devices.xbee.xbee_devices.xbee_xbr:XBeeXBR
      settings:
        xbee_device_manager: <instance name>
        extended_address: <sensor address>
        sample_rate_ms: 5000

Settings
--------------------

xbee_device_manager (required)
    Name of the xbee_device_manager device declared in the devices
    section.

extended_address (required)
    The extended address of the XBee Sensor device you would like to
    monitor.

sample_rate_ms (required)
    The sample rate of the XBee adapter in milliseconds.

Channels
====================

light (Get, type: float, units: brightness)
    Provides a unit-less measure of light intensity.  The full range of
    values is from zero to 1200 with a roughly linear proportional
    correspondence from zero to 10,000 lux.  However, the value is not
    calibrated to correspond to any fixed standard.

temperature (Get, type: float, units: C)
    Temperature as measured by the wall router.


