https://github.com/majamassarini/knx-stack
A Python 3 KNX stack, not complete but easily extensible. Able to encode/decode messages both for USB HID and KNXnet IP.
https://github.com/majamassarini/knx-stack
automate-home eib home-automation knx knxnet knxnetip library python python3 stack usbhid
Last synced: 3 months ago
JSON representation
A Python 3 KNX stack, not complete but easily extensible. Able to encode/decode messages both for USB HID and KNXnet IP.
- Host: GitHub
- URL: https://github.com/majamassarini/knx-stack
- Owner: majamassarini
- License: mit
- Created: 2020-09-04T12:31:28.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-01-06T20:20:12.000Z (over 1 year ago)
- Last Synced: 2025-08-20T03:43:15.269Z (10 months ago)
- Topics: automate-home, eib, home-automation, knx, knxnet, knxnetip, library, python, python3, stack, usbhid
- Language: Python
- Homepage: https://maja-massarini-knx-stack.readthedocs-hosted.com/en/latest/
- Size: 191 KB
- Stars: 7
- Watchers: 1
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.txt
- License: COPYING
Awesome Lists containing this project
README
# knx-stack
[](https://travis-ci.com/majamassarini/knx-stack)
[](https://codecov.io/gh/majamassarini/knx-stack)
[](https://knx-stack.readthedocs.io/en/latest/?badge=latest)
A Python 3 KNX stack, not complete but easily extensible.
It is able to *encode/decode* knx messages for both **USB HID** and **KNXnet IP**.
It can be used with an **asynchronous** or **synchronous** client.
## Examples
### Setup
```python
>>> import knx_stack
>>> individual_address = knx_stack.Address(0x0001)
>>> abcd = knx_stack.GroupAddress(free_style=0xABCD)
>>> abce = knx_stack.GroupAddress(three_level_style=knx_stack.address.ThreeLevelStyle(main=21, middle=3, sub=206))
>>> abcf = knx_stack.GroupAddress(two_level_style=knx_stack.address.TwoLevelStyle(main=21, sub=975))
>>> asap_1 = knx_stack.ASAP(1, "on/off light")
>>> asap_2 = knx_stack.ASAP(2, "info on/off light")
>>> asap_3 = knx_stack.ASAP(3, "two temperature sensors (together)")
>>> address_table = knx_stack.AddressTable(individual_address, [], 255)
>>> association_table = knx_stack.AssociationTable(address_table, [])
>>> association_table.associate(asap_1, [abcd])
>>> association_table.associate(asap_2, [abcd])
>>> association_table.associate(asap_3, [abce, abcf])
>>> group_object_table = knx_stack.GroupObjectTable({asap_1: knx_stack.datapointtypes.DPT_Switch,
... asap_2: knx_stack.datapointtypes.DPT_Switch,
... asap_3: knx_stack.datapointtypes.DPT_Value_Temp,
... })
>>> association_table
AssociationTable: asap -> addresses
0 (individual address) -> [0x0001]
1 (on/off light) -> [(0xABCD 21/973 21/3/205)]
2 (info on/off light) -> [(0xABCD 21/973 21/3/205)]
3 (two temperature sensors (together)) -> [(0xABCE 21/974 21/3/206), (0xABCF 21/975 21/3/207)]
AddressTable: individual address: 0x0001, max_size=255
tsap -> individual address
0 -> 0x0001
tsap -> group address (hex_free_style two_level_style three_level_style)
1 -> (0xABCD 21/973 21/3/205)
2 -> (0xABCE 21/974 21/3/206)
3 -> (0xABCF 21/975 21/3/207)
>>> group_object_table
GroupObjectTable: ASAP -> datapointtype
1 (on/off light) -> DPT_Switch
2 (info on/off light) -> DPT_Switch
3 (two temperature sensors (together)) -> DPT_Value_Temp
```
### USB HID decode/encode
```python
>>> state = knx_stack.State(knx_stack.state.Medium.usb_hid, association_table, group_object_table)
>>> msg = knx_stack.Msg.make_from_str("0113130008000B010300002900BCE00001ABCD010080")
>>> knx_stack.decode_msg(state, msg)
[GroupValueWriteInd (DPT_Switch {'action': 'off'} for asap 1 (on/off light)), GroupValueWriteInd (DPT_Switch {'action': 'off'} for asap 2 (info on/off light))]
>>> msg = knx_stack.Msg.make_from_str("0113130008000B010300002900BCE00001ABCC010081")
>>> knx_stack.decode_msg(state, msg)
[]
>>> msg = knx_stack.Msg.make_from_str("0113140008000C010300002900B4E00001ABCE02008005")
>>> knx_stack.decode_msg(state, msg)
[GroupValueWriteInd (DPT_Value_Temp: {'decoded_value': 0.05} for asap 3 (two temperature sensors (together)))]
>>> req = knx_stack.layer.application.a_group_value_read.req.Msg(asap=asap_3)
>>> knx_stack.encode_msg(state, req)
0113130008000B01030000110096E00000ABCE010000
>>> dpt = knx_stack.datapointtypes.DPT_Value_Temp()
>>> dpt.encode(0.05)
>>> req = knx_stack.layer.application.a_group_value_write.req.Msg(asap=asap_3, dpt=dpt)
>>> knx_stack.encode_msg(state, req)
0113150008000D01030000110096E00000ABCE0300800005
```
### KNXnet IP decode/encode
```python
>>> state = knx_stack.knxnet_ip.State(knx_stack.state.Medium.knxnet_ip, association_table, group_object_table)
>>> state.sequence_counter_remote = 1
>>> msg = knx_stack.knxnet_ip.Msg.make_from_str("061004200015047401002900BCE00001ABCD010080")
>>> knx_stack.decode_msg(state, msg)
[TunnelingReq(sequence counter=1, status=), GroupValueWriteInd (DPT_Switch {'action': 'off'} for asap 1 (on/off light)), GroupValueWriteInd (DPT_Switch {'action': 'off'} for asap 2 (info on/off light))]
>>> msg = knx_stack.knxnet_ip.Msg.make_from_str("061004200016047401002900B4E00001ABCE02008005")
>>> knx_stack.decode_msg(state, msg)
[TunnelingReq(sequence counter=1, status=), GroupValueWriteInd (DPT_Value_Temp: {'decoded_value': 0.05} for asap 3 (two temperature sensors (together)))]
>>> req = knx_stack.layer.application.a_group_value_read.req.Msg(asap=asap_3)
>>> knx_stack.encode_msg(state, req)
06100420001504000000110096E00000ABCE010000
>>> dpt = knx_stack.datapointtypes.DPT_Value_Temp()
>>> dpt.encode(0.05)
>>> req = knx_stack.layer.application.a_group_value_write.req.Msg(asap=asap_3, dpt=dpt)
>>> knx_stack.encode_msg(state, req)
06100420001704000000110096E00000ABCE0300800005
```
### Encode from a dictionary
```python
>>> state = knx_stack.State(knx_stack.state.Medium.usb_hid, association_table, group_object_table)
>>> factory = knx_stack.datapointtypes.DPT_Factory()
>>> dpt = factory.make("DPT_Switch", {"action": "off"})
>>> req = knx_stack.layer.application.a_group_value_write.req.Msg(asap=asap_1, dpt=dpt)
>>> req
GroupValueWriteReq (DPT_Switch {'action': 'off'} for asap 1 (on/off light))
>>> knx_stack.encode_msg(state, req)
0113130008000B01030000110096E00000ABCD010080
```
### Decode to a dictionary
```python
>>> state = knx_stack.State(knx_stack.state.Medium.usb_hid, association_table, group_object_table)
>>> msg = knx_stack.knxnet_ip.Msg.make_from_str("0113130008000B01030000290096E00000ABCD010080")
>>> msgs = knx_stack.decode_msg(state, msg)
>>> msgs
[GroupValueWriteInd (DPT_Switch {'action': 'off'} for asap 1 (on/off light)), GroupValueWriteInd (DPT_Switch {'action': 'off'} for asap 2 (info on/off light))]
>>> factory = knx_stack.datapointtypes.Description_Factory()
>>> factory.make(msgs[0].dpt)
('DPT_Switch', {'action': 'off'})
```
## Installation
```
pip install knx-stack
```
## Diving In
[Documentation](https://knx-stack.readthedocs.io/en/latest/?badge=latest)
## Contributing
Pull requests are welcome.
## License
knx-stack is licensed under the MIT license.