andweber / kalliope_neuron_loxscontrol

A Kalliope Neuron for controlling a Loxone Homeautomation System

Kalliope LoxScontrol Neuron

Synopsis

This neuron allows to control a Loxone Homeautomation from Kalliope.

This project is a non-commercial community project and not connected to the company Loxone.

Version and history

Version 0.1 - unstable

• this is still an unstable preview version

Installation

/!\ You need to have a running Kalliope Core installation. This is only a community module for Kalliope.

kalliope install --git-url https://github.com/kalliope-project/kalliope_neuron_loxone.git

For any further documentation about the usage of Kalliope, please refer to the Kalliope project.

As an alternative have a look at the LoxBerry project. There is a LoxBerry plugin with Kalliope and this neuron preinstalled.

Options

parameter	required	default	choices	comment
lx_ip	YES			Miniserver IP
lx_name	YES			User info.
lx_password	YES			User info.
action	YES		change, list	change a state
control_name	NO			Name of the element
control_type	NO		lights, shading, room	Type of the element
newstate	NO		on, off, ...	state to set, or value

Return Values

Name	Description	Type	sample
status_code	return value	str

Synapses example

Simple example :

  - name: "lx_turnon_light"
    signals:
      - order: "Turn on {{ control_name }}"
    neurons:
      - loxScontrol:
          lx_ip: "lx ip"
          lx_user: "lx user name"
          lx_password: "my_password"
          action: "change"
          control_name: "{{ control_name }}"
          newstate: "on"
          say_template: 
            -  "Your order was {{ status_code }}."    

A complex example is included in brain_examples.

Notes

License

Copyright (c) 2017. All rights reserved.

Loxone is a registered trademark by the loxone company. See www.loxone.com.

Kalliope is covered by the MIT license, a permissive free software license that lets you do anything you want with the source code, as long as you provide back attribution and "don't hold you liable". For the full license text see the LICENSE.md file.

kalliope_neuron_loxscontrol's Issues

LoxBerry Integration

Should be integrated in http://www.loxwiki.eu/display/LOXBERRY/LoxBerry

update DNA file to support Kalliope v0.5.0

We've update the major release of Kalliope to v0.5.0 due to the breaking changes we made by adding hook feature.
You just need to add the new tag to your DNA file like here.