This page provides an overview of the different object representations used in the HomeAutomation control software stack. The general reasoning behind Devices, Actions, Events and stuff is explained on another page.
Public attributes below means that these attributes are to be accessed through the attr_* method calls.
The objects listed here can be imported from files contructed from the lowercase class name with "class" appended. For example, Device can be imported from deviceclass, IODev from iodevclass.
Objects
/Device - the root class for device representations
/Device/Alarmclock - a generator for events at configurable times
/Device/IODev - everything attached to the CAN bus
/Device/IODev/DimmerOutput - a controller for (e.g.) a lighting dimmer
/Device/IODev/ToggleButton - a binary momentary switch input, e.g. a light switch
/Device/IODev/RelayOutput - a binary output controlling a 230V output through an installation relay
Data structures
action
This structure is defined on another page.
canmsg
A CAN message is internally represented by a dictionary containing the following entries:
type = 'canmsg'
busaddr containing the device address in the CAN datagram in integer format
data[0..<datalen - 1>] containing the data bytes of the message as integer values
datalen the number of data bytes included in this message as an integer value.
mtid the message type identification number as an integer value
rtr = True|False indicating whether a Remote Transmit Request is represented by this dataset
sender the unique id of the module that constructed this dictionary in string format
event
This structure is defined on another page.
rule
This structure is defined on another page, and only listed here for completeness. Rules are not used by device objects but the HAControl object.
THIS DATA IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DATA, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
All product and brand names mentioned on there pages and in the source code are registered names and/or trademarks of the respective owner and are mentioned for identification purposes only.
For a full copyright notice, please see this link. For imprint and contact information, please see http://www.thiemo.net/.