SBrick-Framework

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

SBrick-Framework

★ 26 Open GitHub ↗

Python interface to control SBrick devices.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# SBrick-Framework
This is a python based interface for control SBrick devices. What is the benefit when you use SBrick-Framework:
* Get detailed information: UUID, service, characteristic, adc(voltage, temperature) information...
* Control LEGO power functions concurrently:
  * Drive power functions
  * Stop power functions
* Support multiple SBrick devices (not test yet)
  
A thread is created to handle a LEGO power function (a channel), and this means you can control LEGO power functions concurrently. The last drive function will overwrite the execution time of the related power function that is applied previously.

SBrick-Framework is implemented by `BlueZ + SBrick protocol + libuv + MQTT protocol + mosquitto broker`, and the code is tested by python 3.4 on Raspberry Pi 3(Raspbian Jessie).

Aarchitecture overview: 
<img src="sbrick_arch.jpg" width="480" alt="Combined Image" />

## User-Story
* <a href="https://github.com/BensonHsu/SBrick-Framework/tree/master/story/ferriswheel">LEGO Ferris Wheel Set 10247</a>

## SBrick Protocol
SbrickAPI is based on SBrick protocol 17 (https://social.sbrick.com/wiki/view/pageId/11/slug/the-sbrick-ble-protocol)

## Requirements
* Python 3.4
* BlueZ
* bluepy v1.1.4
* pyuv
* paho-mqtt
* mosquitto

### BlueZ
BlueZ is a official Bluetooth protocol stack on Linux. 
Useful commands for BlueZ:
```bash
$ hciconfig -a
$ sudo hciconfig hci0 up
$ sudo hcitool lescan
$ bluetoothctl
```
Must make sure bluetooth control is active.
```bash
$ sudo hciconfig hci0 up
```

### bluepy v1.1.4
bluepy is a Python module which provides an interface to Bluetooth LE on Linux. 
Ref: https://github.com/IanHarvey/bluepy
```bash
$ pip3 install bluepy==1.1.4
```

### pyuv
pyuv is a Python module which provides an interface to libuv. 
Ref: https://github.com/saghul/pyuv
```bash
$ sudo pip3 install pyuv
```

### paho-mqtt
paho-mqtt is a Python module which provides an interface to MQTT protocol. 
Ref: https://pypi.python.org/pypi/paho-mqtt/1.2.3
```bash
$ sudo pip3 install paho-mqtt
```

### mosquitto
mosquitto is an open source message broker thant implements MQTT protocol versions 3.1 and 3.1.1 
Ref: https://mosquitto.org/
```bash
$ apt-get install mosquitto mosquitto-clients
$ sudo systemctl status mosquitto
$ sudo systemctl start mosquitto
$ sudo systemctl enable mosquitto
```

## Usage
### Start SBrick daemon:
1. Usage of `sbrick_server.py`
```bash
$ python3 sbrick_server.py -h
usage: sbrick_server.py [-h] (--connect | --scan) [--broker-ip BROKER_IP]
                        [--broker-port BROKER_PORT]
                        [--broker-user BROKER_USER]
                        [--broker-passwd BROKER_PASSWD]
                        [--sbrick-id SBRICK_ID [SBRICK_ID ...]]
                        [--log-level LOG_LEVEL]

optional arguments:
  -h, --help            show this help message and exit
  --connect             Connect to SBrick
  --scan                Scan for getting SBrick information

--connect:
  --broker-ip BROKER_IP
                        MQTT broker ip address. Default is 127.0.0.1
  --broker-port BROKER_PORT
                        MQTT broker port. Default is 1883
  --broker-user BROKER_USER
                        MQTT broker username. Default is None
  --broker-passwd BROKER_PASSWD
                        MQTT broker password. Default is None
  --sbrick-id SBRICK_ID [SBRICK_ID ...]
                        list of SBrick MAC to connect to
  --log-level LOG_LEVEL
                        Log verbose level. Default is INFO. [DEBUG | INFO |
                        WARNING | ERROR | CRITICAL]
```

2. Scan SBrick devices. You can get SBrick MAC in this step. (must run as root)
```bash
$ sudo python3 sbrick_server.py --scan
$ sudo hcitool lescan
```

3. Start daemon server with connecting to a SBrick device. (must run as root)
```bash
$ sudo python3 sbrick_server.py --connect --broker-ip 127.0.0.1 --broker-port 1883 --log-level debug --sbrick-id 11:22:33:44:55:66
```

4. You can also control multiple SBrick devices. The usage is below:
```bash
$ sudo python3 sbrick_server.py --connect ..... --sbrick-id <SBrick1 MAC> <SBrick2 MAC> <SBrick3 MAC>
```

### Code example of using SBrick Client API
Example of `SbrickIpcClient` class:
```python
from lib.sbrick_m2mipc import SbrickIpcClient

# MQTT connect
client = SbrickIpcClient(broker_ip='127.0.0.1', broker_port=1883)
client.connect()

# Get voltage and temperature of a SBrick device
json_response = client.rr_get_adc(sbrick_id='11:22:33:44:55:66', timeout=5)

# Get information of UUID, sercies and characteristics of a SBrick device
json_response = client.rr_get_service(sbrick_id='11:22:33:44:55:66', timeout=5)

# Get general information of a SBrick device
json_response = client.rr_get_general(sbrick_id='11:22:33:44:55:66', timeout=5)

# Stop power functions
client.publish_stop(sbrick_id='11:22:33:44:55:66', channel_list=['00', '01'])

# Drive a power function
client.publish_drive(sbrick_id='11:22:33:44:55:66',
                     channel='00',
                     direction='00',
                     power='f0',
                     exec_time=10)
                 
# MQTT disconnect
client.disconnect()
```

## SBrick Client API
`SbrickIpcClient` class has below methods:
* __SbrickIpcClient()__
  * Init class
  * _Parameters_:
    * `logger`       : logger object. logging. Default is sys.stdout
    * `broker_ip`    : string.        IP address of MQTT. Default is 127.0.0.1
    * `broker_port`  : number.        Port number of MQTT. Default is 1883
* __publish_dirve()__
  * Drive s LEGO power function
  * _Parameters_:
    * `sbrick_id`    : string. SBrick mac address. 11:22:33:44:55:66
    * `channel`      : string. hex_string. the LEGO power function port you want to drive. 00, 01, 02, 03
    * `direction`    : string. clockwise or counterclockwise. hex_string. 00, 01
    * `power`        : string. hex_string. 00 ~ FF
    * `exec_time`    : number. the executing time of LEGO power function in seconds, 5566 means forever
  * _Return_:
    * No return
* __publish_stop()__
  * Stop LEGO power functions
  * _Parameters_:
    * `sbrick_id`    : string. SBrick mac address. 11:22:33:44:55:66
    * `channel_list` : list.   list of channels to stop. [00, 01]
  * _Return_:
    * No return
* __rr_get_service()__
  * Get information of UUID, services and characteristis of a SBrick device
  * _Parameters_:
    * `sbrick_id`    : string. SBrick mac address. 11:22:33:44:55:66
    * `timeout`      : number. timeout to get service in seconds.
  * _Return_:
    * Information in JSON format.
    * `ret_code`: 100(success), 220(bad_param), 300(timeout)
* __rr_get_adc()__
  * Get information of voltage and temperature of a SBrick device
  * _Parameters_:
    * `sbrick_id`    : string. SBrick mac address. 11:22:33:44:55:66
    * `timeout`      : number. timeout to get service in seconds.
  * _Return_:
    * Information in JSON format.
    * `ret_code`: 100(success), 220(bad_param), 300(timeout)
* __rr_get_general()__
  * Get general information of a SBrick device
  * _Parameters_:
    * `sbrick_id`    : string. SBrick mac address. 11:22:33:44:55:66
    * `timeout`      : number. timeout to get service in seconds.
  * _Return_:
    * Information in JSON format.
    * `ret_code`: 100(success), 220(bad_param), 300(timeout)

SBrick-Framework

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README