What is iqrfpy?
iqrfpy is a library that provides a python API for interacting with the IQRF network utilizing the DPA framework (DPA) or IQRF Gateway Daemon (Daemon) JSON API. Communication between a python runtime and the IQRF network is facilitated by transports.
For communication with Daemon, only the MQTT transport is implemented at this time. However, this library provides an abstract transport class, allowing for custom communication implementations.
The library provides classes for serialization of requests and deserialization of responses to message class objects.
Quick start
Before installing the library, it is recommended to first create a virtual environment. Virtual environments help isolate python installations as well as pip packages independent of the operating system.
A virtual environment can be created and launched using the following commands:
python3 -m venv <dir>
source <dir>/bin/activate
iqrfpy can be installed using the pip utility:
python3 -m pip install -U iqrfpy
Serialize requests to DPA:
from iqrfpy.peripherals.coordinator.requests.addr_info import AddrInfoRequest
req = AddrInfoRequest()
req_packet = req.to_dpa()
print(req_packet)
Serialize requests to JSON:
from iqrfpy.peripherals.coordinator.requests.addr_info import AddrInfoRequest
req = AddrInfoRequest()
json_req = req.to_json()
print(json_req)
Parse DPA responses:
from iqrfpy.peripherals.coordinator.responses import AddrInfoResponse
from iqrfpy.response_factory import ResponseFactory
def handle_addr_info_response(response: AddrInfoResponse) -> None:
print(f'peripheral: {response.pnum}')
print(f'peripheral command: {response.pcmd}')
status = response.rcode
if status == 0:
print(f'Addr info response dev_nr: {response.dev_nr}')
print(f'Addr info response did: {response.did}')
dpa_rsp_packet = b'\x00\x00\x00\x80\x00\x00\x00\x40\x0a\x2a'
dpa_rsp = ResponseFactory.get_response_from_dpa(dpa=dpa_rsp_packet)
handle_addr_info_response(response=dpa_rsp)
Parse JSON responses:
from iqrfpy.peripherals.coordinator.responses import AddrInfoResponse
from iqrfpy.response_factory import ResponseFactory
def handle_addr_info_response(response: AddrInfoResponse) -> None:
print(f'peripheral: {response.pnum}')
print(f'peripheral command: {response.pcmd}')
status = response.rcode
if status == 0:
print(f'Addr info response dev_nr: {response.dev_nr}')
print(f'Addr info response did: {response.did}')
daemon_rsp_json = {
"mType": "iqrfEmbedCoordinator_AddrInfo",
"data": {
"msgId": "testEmbedCoordinator",
"rsp": {
"nAdr": 0,
"hwpId": 0,
"rCode": 0,
"dpaVal": 64,
"result": {
"devNr": 0,
"did": 42
}
},
"insId": "iqrfgd2-1",
"status": 0
}
}
json_rsp = ResponseFactory.get_response_from_json(json=daemon_rsp_json)
handle_addr_info_response(response=json_rsp)
Documentation
For more information, check out our API reference.
2 maintainers
Release files for iqrfpy 0.2.13
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| iqrfpy-0.2.13.tar.gz | 108.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| iqrfpy-0.2.13-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 385.2 kB
Release files / iqrfpy-0.2.13.tar.gz
| Download URL | iqrfpy-0.2.13.tar.gz |
|---|---|
| Size | 108.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
41400cf94a6d952edbd9e1e33bbe4bb4733c5f2e7f4be5a9179ac024db5fd83e
|
|
BLAKE2b-256 checksum How to use checksums |
02a2171da4c7b4e96a6ca98b4e963e1ae70300198971d5299b7f41068c7d2723
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|
Release files / iqrfpy-0.2.13-py3-none-any.whl
| Download URL | iqrfpy-0.2.13-py3-none-any.whl |
|---|---|
| Size | 276.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3ec953e48864415657d71fceaa62e44fce7ef7681b82076d980529323e329085
|
|
BLAKE2b-256 checksum How to use checksums |
f0d33ced67960edaf4ecba6ec444060099082da49cc253d42646733410fe6937
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.5
|
