npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

homebridge-loxone-ws-adv-cstm

v1.4.0

Published

Websocket based Loxone plugin for homebridge advanced version (https://github.com/nfarina/homebridge)

Downloads

9

Readme

homebridge-loxone-ws-adv

Websocket based Loxone plugin for homebridge

This is a Loxone plugin for Homebridge The plugin will automatically retrieve and communicate with all these items from your Loxone setup:

  • Lights (Switches, Dimmers and Color leds)
  • Other Switches
  • Pushbuttons
  • Window blinds
  • Temperature sensors
  • (other types can be added easily)

The only configuration needed is the credentials to your Loxone miniserver.

Benefits

  • Realtime and very fast 2-way updates by using the websocket connection
  • One-touch deployment through automatic import of Loxone controls

Prerequisites

Homebridge Follow all the installation steps there.

Installation

Install the plugin through npm or download the files from here.

$ sudo npm install -g homebridge-loxone-ws-adv

Or update to latest version when already installed:

$ sudo npm update -g homebridge-loxone-ws-adv

Note: the plugin requires extra node modules, but these should be automatically installed:

  • node-lox-ws-api
  • request
Homebridge config.json

Add the platform section to your Homebridge config.json (usually in ~/.homebridge):

{
    "bridge": {
        "name": "Homebridge",
        "username": "CA:AA:12:34:56:78",
        "port": 51826,
        "pin": "012-34-567"
    },

    "description": "Your config file.",

    "platforms": [
        {
            "platform": "LoxoneWs",
            "name": "Loxone",
            "host": "192.168.1.2",
            "port": "12345",
            "username": "homebridge",
            "password": "somepassword"
        }
    ]
}

Replace fields

  • host by the IP of your loxone miniserver
  • port by the port of your miniserver (use 80 if no special port)
  • username by the Loxone username
  • password by the Loxone password

I strongly suggest to create a dedicate Loxone user through Loxone Config (eg homebridge). Like this you can restrict access to sensitive items or filter out unneeded controls.

Optional configuration fields in the platform section

rooms

To specify an array of interested rooms to filter on. If empty or not given, all elements are used. Eg: specifying "rooms" : ["Kitchen", "Bedroom"] will limit your bridge to only elements from those 2 rooms.

moodSwitches

Can use Loxone moods which are part of LightControllerV2 elements. (In order to use this, you'll need to convert any 'old' LightControllers blocks.)

Has 3 possible values

  • none : does not include moods. This is the default in case not given.
  • all : include moods as actionable item
  • only : only include moods and filter out any other element

Assumptions

To create the correct accessory type from Loxone items, some attribute parsing is required. (Eg a Loxone Switch can be a Switch or a LightBulb, and InfoOnlyAnalog type can be a temperature sensor but also anything else.) This is covered in the checkCustomAttrs function in ItemFactory. Adapt it to your needs. Currently these assumptions are made:

  • temperature sensor names start with 'Temperat'
  • light switches are in a Loxone category using the lightbulb icon

The controls will be named like you named them in Loxone. Rename them through the iOS Home app to make it more intuitive for using with Siri. Eg LIGHT_KITCHEN can be renamed to 'main light' and added to room Kitchen. Then you can ask Siri to 'turn on the main light in the kitchen'.

Limitations

rooms The Homebridge/HAP protocol does currently not allow attaching the Loxone rooms to the accessories. That is a manual action to be done once using the IOS Home app (or the Eve app which is much more user-friendly).

Special note: organizing into rooms can be done from Eve, but renaming the items should (unfortunately) be done from the IOS Home app. Name changes in Eve are not reflected in Home and thus not known by Siri.

100 items HomeKit has a limit of 100 accessories per bridge. If you have a large Loxone setup, try to filter unneeded items out either through a dedicated Loxone usergroup or in the checkCustomAttrs function.

pushbuttons Since Homekit has no pushbutton concept, I implemented pushbuttons as switches in Homekit. Telling Siri to put them On will send a pulse to the pushbutton. In Homekit, they will appear to be On for a second.

Advanced

The Event type is foreseen for your convenience, but not currently used. It can be used for pushbuttons when you're only interested in reading from Homekit and not controlling it. That could be useful for setting triggers, eg a Pushbutton event which causes a Homekit scene to become active.

Problem solving

If your have troubles getting the states on your iOS device, try removing the files in your 'persists' folder (usually in ~/.homebridge/persist) and restarting homebridge.

License

The plugin is released under MIT license, which means you can do whatever you want with it as long as you give credit.

Credits

The original Loxone WS work was done by Sroose

Attribution goes towards Tommaso Marchionni. The structure of this code is based on his openHAB plugin.

The original HomeKit API work was done by Khaos Tian in his HAP-NodeJS project.

The homebridge component on which this plugin is built was created by Nick Farina.

I've made use of the NodeJS Loxone websocket API created by Ladislav Dokulil

Thanks to all contributors!