Skip to content

Latest commit

 

History

History
197 lines (137 loc) · 6.64 KB

README.md

File metadata and controls

197 lines (137 loc) · 6.64 KB

Community Hass.io Add-ons: KNXD

GitHub Release Project Stage License

Supports aarch64 Architecture Supports amd64 Architecture Supports armhf Architecture Supports armv7 Architecture Supports i386 Architecture

Project Maintenance GitHub Activity

Buy me a coffee

This add-on sets up a knxd daemon that could also act as a tunnel or TCP/IP gateway in addition to connect xknx component to it.

About

This add-on sets up a knxd daemon on the hass-io installation, enabling it to act as a TCP/IP gateway for the KNX system.

WARNING

Features

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.

  1. Add my Hass.io add-ons repository to your Hass.io instance.
  2. Install the "knxd" add-on.
  3. Configure the addon
  4. Start the "knxd" add-on.
  5. Check the logs of the "knxd" add-on to see if everything went well.

NOTE: Do not add this repository to Hass.io, please use: https://github.com/palhaland/hassio-addon-repo.

Configuration

Note: Remember to restart the add-on when the configuration is changed.

knxd add-on configuration:

{
  “address”: “0.0.1”,
  “client_address”: “0.0.1:10”,
  “interface”: “tpuart”,
  “device”: “/dev/ttyAMA0”,
  “custom_config”: “”
}

Note: This is just an example, don't copy and paste it! Create your own!

Option group knxd


The following options are for the option group: knxd.

Option address: 0.0.1

This option allows you to change the address the knxd daemon will use on the KNX bus network.

Option client_address: 0.0.2:10

This option allows you to change what addresses the clients that connect through the daemon can use. In this case it is from 1:10

Option interface tpuart

Depending on what type of device you have connected to the Home-Assistant device, you need to select the correct one here. Can can be one of:

  • tpuart
  • usb

Option device: /dev/ttyAMA0

The default device to communicate with.

Option custom_config: ``

This is for additional configuration options to start the knxd server with.

Known issues and limitations

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Support

Got questions?

You have several options to get them answered:

You could also open an issue here GitHub.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! 😍

Authors & contributors

For a full list of all authors and contributors, check the contributor's page.

We have got some Hass.io add-ons for you

Want some more functionality to your Hass.io Home Assistant instance?

We have created multiple add-ons for Hass.io. For a full list, check out our GitHub Repository.

License

MIT License

Copyright (c) 2019 Pål Håland

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.