Skip to content

Commit

Permalink
Initial matter Python end-device (#11116)
Browse files Browse the repository at this point in the history
This PR facilitates to create a Python based matter end-device.

* Adds sample with README in examples/lighting-app/python
  * This sample requires a DALI-USB-interface
* build-chip-wheel.py was auto-formatted
* Typo fixed in operational-credentials-server.cpp
* Correct IP commissioning cluster docs
* Add python-dali as a requirement
* Add Options and re-enable BLE and WiFi
* Use lighting-app.zap for client python device.
* Restyled
  • Loading branch information
markus-becker-tridonic-com authored and pull[bot] committed Jul 6, 2022
1 parent 44a5979 commit 1261920
Show file tree
Hide file tree
Showing 18 changed files with 1,046 additions and 64 deletions.
1 change: 1 addition & 0 deletions .github/.wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,7 @@ DevKitC
DevKitM
df
dfu
dhclient
DHCP
DHCPC
DHCPv
Expand Down
48 changes: 48 additions & 0 deletions examples/lighting-app/python/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Python based lighting example (bridge) device to DALI.

## Installation

Build the Python/C library:

```shell
cd ~/connectedhomeip/
git submodule update --init
source scripts/activate.sh

./scripts/build_python_device.sh --chip_detail_logging true

sudo su # dhclient is called, needs root
source ./out/python_env/bin/activate
```

Install the python dependencies:

```shell
pip3 install python-dali
```

Plug-in a python-dali compatible USB-DALI interface.

## Usage

Run the Python lighting matter device:

```shell
cd examples/lighting-app/python
python lighting.py
```

Control the Python lighting matter device:

```shell
source ./out/python_env/bin/activate

chip-device-ctrl

chip-device-ctrl > connect -ble 3840 20202021 12344321
chip-device-ctrl > zcl NetworkCommissioning AddWiFiNetwork 12344321 0 0 ssid=str:YOUR_SSID credentials=str:YOUR_PASSWORD breadcrumb=0 timeoutMs=1000
chip-device-ctrl > zcl NetworkCommissioning EnableNetwork 12344321 0 0 networkID=str:YOUR_SSID breadcrumb=0 timeoutMs=1000
chip-device-ctrl > close-ble
chip-device-ctrl > resolve 5544332211 1 (pass appropriate fabric ID and node ID, you can get this from get-fabricid)
chip-device-ctrl > zcl OnOff Toggle 12344321 1 0
```
238 changes: 238 additions & 0 deletions examples/lighting-app/python/lighting.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,238 @@
#
# Copyright (c) 2021 Project CHIP Authors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

from chip.server import (
GetLibraryHandle,
NativeLibraryHandleMethodArguments,
PostAttributeChangeCallback,
)

from chip.exceptions import ChipStackError

from ctypes import CFUNCTYPE, c_char_p, c_int32, c_uint8

import sys
import os

import textwrap
import string

from cmd import Cmd

import asyncio
import threading

from dali.driver.hid import tridonic
from dali.gear.general import RecallMaxLevel, Off, DAPC
from dali.address import Broadcast, Short

dali_loop = None
dev = None


async def dali_on(is_on: bool):
global dali_loop
global dev

await dev.connected.wait()
if (is_on):
await dev.send(RecallMaxLevel(Broadcast()))
else:
await dev.send(Off(Broadcast()))


async def dali_level(level: int):
global dali_loop
global dev

await dev.connected.wait()
await dev.send(DAPC(Broadcast(), level))


def daliworker():
global dali_loop
global dev

dali_loop = asyncio.new_event_loop()
dev = tridonic("/dev/dali/daliusb-*", glob=True, loop=dali_loop)
dev.connect()

asyncio.set_event_loop(dali_loop)
dali_loop.run_forever()


class LightingMgrCmd(Cmd):
def __init__(self, rendezvousAddr=None, controllerNodeId=0, bluetoothAdapter=None):
self.lastNetworkId = None

Cmd.__init__(self)

Cmd.identchars = string.ascii_letters + string.digits + "-"

if sys.stdin.isatty():
self.prompt = "chip-lighting > "
else:
self.use_rawinput = 0
self.prompt = ""

LightingMgrCmd.command_names.sort()

self.historyFileName = os.path.expanduser("~/.chip-lighting-history")

try:
import readline

if "libedit" in readline.__doc__:
readline.parse_and_bind("bind ^I rl_complete")
readline.set_completer_delims(" ")
try:
readline.read_history_file(self.historyFileName)
except IOError:
pass
except ImportError:
pass

command_names = [
"help"
]

def parseline(self, line):
cmd, arg, line = Cmd.parseline(self, line)
if cmd:
cmd = self.shortCommandName(cmd)
line = cmd + " " + arg
return cmd, arg, line

def completenames(self, text, *ignored):
return [
name + " "
for name in LightingMgrCmd.command_names
if name.startswith(text) or self.shortCommandName(name).startswith(text)
]

def shortCommandName(self, cmd):
return cmd.replace("-", "")

def precmd(self, line):
if not self.use_rawinput and line != "EOF" and line != "":
print(">>> " + line)
return line

def postcmd(self, stop, line):
if not stop and self.use_rawinput:
self.prompt = "chip-lighting > "
return stop

def postloop(self):
try:
import readline

try:
readline.write_history_file(self.historyFileName)
except IOError:
pass
except ImportError:
pass

def do_help(self, line):
"""
help
Print the help
"""
if line:
cmd, arg, unused = self.parseline(line)
try:
doc = getattr(self, "do_" + cmd).__doc__
except AttributeError:
doc = None
if doc:
self.stdout.write("%s\n" % textwrap.dedent(doc))
else:
self.stdout.write("No help on %s\n" % (line))
else:
self.print_topics(
"\nAvailable commands (type help <name> for more information):",
LightingMgrCmd.command_names,
15,
80,
)


@PostAttributeChangeCallback
def attributeChangeCallback(
endpoint: int,
clusterId: int,
attributeId: int,
mask: int,
manufacturerCode: int,
xx_type: int,
size: int,
value: bytes,
):
global dali_loop
if endpoint == 1:
if clusterId == 6 and attributeId == 0:
if len(value) == 1 and value[0] == 1:
# print("[PY] light on")
future = asyncio.run_coroutine_threadsafe(
dali_on(True), dali_loop)
future.result()
else:
# print("[PY] light off")
future = asyncio.run_coroutine_threadsafe(
dali_on(False), dali_loop)
future.result()
elif clusterId == 8 and attributeId == 0:
if len(value) == 2:
# print("[PY] level {}".format(value[0]))
future = asyncio.run_coroutine_threadsafe(
dali_level(value[0]), dali_loop)
future.result()
else:
print("[PY] no level")
else:
# print("[PY] [ERR] unhandled cluster {} or attribute {}".format(
# clusterId, attributeId))
pass
else:
print("[PY] [ERR] unhandled endpoint {} ".format(endpoint))


class Lighting:
def __init__(self):
self.chipLib = GetLibraryHandle(attributeChangeCallback)


if __name__ == "__main__":
l = Lighting()

lightMgrCmd = LightingMgrCmd()
print("Chip Lighting Device Shell")
print()

print("Starting DALI async")
threads = []
t = threading.Thread(target=daliworker)
threads.append(t)
t.start()

try:
lightMgrCmd.cmdloop()
except KeyboardInterrupt:
print("\nQuitting")

sys.exit(0)
2 changes: 2 additions & 0 deletions examples/lighting-app/python/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# dali
python-dali
1 change: 1 addition & 0 deletions examples/lighting-app/python/third_party/connectedhomeip
2 changes: 1 addition & 1 deletion scripts/build_python.sh
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ fi
# Create a virtual environment that has access to the built python tools
virtualenv --clear "$ENVIRONMENT_ROOT"

# Activate the new enviroment to register the python WHL
# Activate the new environment to register the python WHL

if [ "$enable_pybindings" == true ]; then
WHEEL=$(ls "$OUTPUT_ROOT"/pybindings/pycontroller/pychip-*.whl | head -n 1)
Expand Down
Loading

0 comments on commit 1261920

Please sign in to comment.