# Syndesi Python Implementation
## Installation
The syndesi Python package can be installed through pip
``pip install syndesi``
The package can also be installed locally by cloning this repository
```bash
git clone ...
cd Syndesi/Python
pip install .
```
## Usage
To instantiate a device / testbench, one must import the device and a suitable adapter
```python
# 1) Import the device
from syndesi.drivers.instruments.mutlimeters.siglent.SDM3055 import SDM3055
# 2) Import the adapter
from syndesi.adapters import IP
# 3) Instantiate the multimeter using its IP
mm = SDM3055(IP("192.168.1.123"))
## 4) Use
voltage = mm.measure_dc_voltage()
```
The Syndesi Python package provides the user with the necessary tools to control compatible devices
- drivers : device-specific implementation
- descriptors : Each class represents a particular way of connecting to a device, the user must provide que necessary information (IP, com port, ID, etc...)
- communication wrapper (wrappers) : Wrappers for low-level communication (TCP, UDP, UART, etc...)
- IP (TCP / UDP)
- UART
- USB (?)
## Layers
The first layer is the "Device" base class
The second layer is made of "Primary drivers". First stage drivers implement mid-level communication protocols like Modbus, SDP, Raw, HTTP, SPCI, etc... Those drivers can be instanciated by the user if he wishes to use a device "as is" (i.e without an application driver)
Next are device drivers. They provide implementation for device-specific operations
Last are the application drivers. These are used to provide application-specific operations that mar or may not be tied to a particular device.
Note that both device drivers and application drivers can be omitted and can also be stacked as all first stage drivers, device drivers and application drivers stem from the same base Class
## SDP
The Syndesi Device Protocol is a light-weight and easy interface to send / receive commands with compatible devices.
## Usecases
- Test gear (multimeters, oscilloscopes, power supply, etc...)
- set values (output voltage, settings, etc...)
- get values (measured voltage, trace, screenshot)
- continuously read data (UART multimeter for instance)
- UART devices (Arduinos, etc...)
- Send / receive raw data
- Custom drivers
- Syndesi devices
- Send / receive formatted data
- USB devices
- Send / receive data using the USB protocol
## Notes
15.08.2023 : The adapters must work with bytearray data only
06.09.2023 : bytearray is changed to bytes everywhere
Raw data
{
"_id": null,
"home_page": "",
"name": "syndesi",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,syndesi,interface,ethernet",
"author": "Sebastien Deriaz",
"author_email": "sebastien.deriaz1@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/47/f9/ecd9dd0ca9865b69e6d27813072f044a10d53cdef25a1a77d32a1bead9f3/syndesi-0.1.5.tar.gz",
"platform": null,
"description": "# Syndesi Python Implementation\n\n## Installation\n\nThe syndesi Python package can be installed through pip\n\n``pip install syndesi``\n\nThe package can also be installed locally by cloning this repository\n\n```bash\ngit clone ...\ncd Syndesi/Python\npip install .\n```\n\n## Usage\n\nTo instantiate a device / testbench, one must import the device and a suitable adapter \n\n```python\n# 1) Import the device\nfrom syndesi.drivers.instruments.mutlimeters.siglent.SDM3055 import SDM3055\n# 2) Import the adapter\nfrom syndesi.adapters import IP\n\n# 3) Instantiate the multimeter using its IP\nmm = SDM3055(IP(\"192.168.1.123\"))\n\n## 4) Use\nvoltage = mm.measure_dc_voltage()\n```\n\nThe Syndesi Python package provides the user with the necessary tools to control compatible devices\n\n- drivers : device-specific implementation\n- descriptors : Each class represents a particular way of connecting to a device, the user must provide que necessary information (IP, com port, ID, etc...)\n- communication wrapper (wrappers) : Wrappers for low-level communication (TCP, UDP, UART, etc...)\n - IP (TCP / UDP)\n - UART\n - USB (?)\n\n## Layers\n\nThe first layer is the \"Device\" base class\n\nThe second layer is made of \"Primary drivers\". First stage drivers implement mid-level communication protocols like Modbus, SDP, Raw, HTTP, SPCI, etc... Those drivers can be instanciated by the user if he wishes to use a device \"as is\" (i.e without an application driver)\n\nNext are device drivers. They provide implementation for device-specific operations\n\nLast are the application drivers. These are used to provide application-specific operations that mar or may not be tied to a particular device.\n\nNote that both device drivers and application drivers can be omitted and can also be stacked as all first stage drivers, device drivers and application drivers stem from the same base Class\n\n## SDP\n\nThe Syndesi Device Protocol is a light-weight and easy interface to send / receive commands with compatible devices.\n\n## Usecases\n\n- Test gear (multimeters, oscilloscopes, power supply, etc...)\n - set values (output voltage, settings, etc...)\n - get values (measured voltage, trace, screenshot)\n - continuously read data (UART multimeter for instance)\n- UART devices (Arduinos, etc...)\n - Send / receive raw data\n - Custom drivers\n- Syndesi devices\n - Send / receive formatted data\n- USB devices\n - Send / receive data using the USB protocol\n\n## Notes\n\n15.08.2023 : The adapters must work with bytearray data only\n\n06.09.2023 : bytearray is changed to bytes everywhere\n",
"bugtrack_url": null,
"license": "",
"summary": "Syndesi",
"version": "0.1.5",
"project_urls": null,
"split_keywords": [
"python",
"syndesi",
"interface",
"ethernet"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ada8758e734211c90a56e823332b031baab573f0c9bbc2cf764b9180c248d6cc",
"md5": "075ec805e0461ebaa08137a6f2f44f94",
"sha256": "dc8c9d17f11f77467d4620a29b10310744961a861e7a72022b624c143d5079e3"
},
"downloads": -1,
"filename": "syndesi-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "075ec805e0461ebaa08137a6f2f44f94",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 32836,
"upload_time": "2023-09-06T10:02:27",
"upload_time_iso_8601": "2023-09-06T10:02:27.711587Z",
"url": "https://files.pythonhosted.org/packages/ad/a8/758e734211c90a56e823332b031baab573f0c9bbc2cf764b9180c248d6cc/syndesi-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "47f9ecd9dd0ca9865b69e6d27813072f044a10d53cdef25a1a77d32a1bead9f3",
"md5": "a1bf82ca0e31f593a8dd85aaa94504bb",
"sha256": "4a70aec424d321941128dfc93876f35ee2a4abc0f97050a89b66d1ed22b80465"
},
"downloads": -1,
"filename": "syndesi-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "a1bf82ca0e31f593a8dd85aaa94504bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24455,
"upload_time": "2023-09-06T10:02:29",
"upload_time_iso_8601": "2023-09-06T10:02:29.157175Z",
"url": "https://files.pythonhosted.org/packages/47/f9/ecd9dd0ca9865b69e6d27813072f044a10d53cdef25a1a77d32a1bead9f3/syndesi-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-06 10:02:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "syndesi"
}
JSON