Skip to main content

A python library for io4edge devices

Project description

io4edge-client-python

python client sdk for io4edge.

io4edge devices are intelligent I/O devices invented by Ci4Rail, connected to the host via network.

This library provides support for the following function blocks within io4edge devices:

  • Analog In TypeA - IOU01, MIO01
  • Binary IO TypeA - IOU01, MIO01
  • CAN Layer2 - IOU03, MIO03, IOU04, MIO04, IOU06
  • MVB Sniffer - IOU03, MIO03
  • Binary IO TypeB - IOU06
  • Binary IO TypeC - IOU07

Currently not supported, but will follow:

  • Motion Sensor - CPU01UC

Not planned: Support for io4edge management functions, such as firmware update. Please use io4edge-client-go for this.

Installation

pip3 install io4edge_client

Usage

See examples in github repo for usage examples.

Running in Docker

To run the examples in a docker container, you can use the provided Dockerfile in examples/docker directory.

In the Dockerfile, Replace dumpstream.py script with your python application path.

To build the docker image, run the following command on your host to build it for your target platform, in this case the target platform linux/arm64:

docker buildx build --platform linux/arm64  -f examples/docker/Dockerfile . --push -t <your-docker-image-name>:<version>

On your target platform, run the container in the host network, so that you can use the service names of the io4edge devices:

docker run --network=host <your-docker-image-name>:<version> <parameters-to-your-python-script>

Copyright

Copyright © 2021-2024 Ci4Rail GmbH engineering@ci4rail.com

io4edge_client_python package is released under Apache 2.0 License, see LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

io4edge_client-1.0.5.tar.gz (22.4 kB view details)

Uploaded Source

Built Distribution

io4edge_client-1.0.5-py3-none-any.whl (39.8 kB view details)

Uploaded Python 3

File details

Details for the file io4edge_client-1.0.5.tar.gz.

File metadata

  • Download URL: io4edge_client-1.0.5.tar.gz
  • Upload date:
  • Size: 22.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for io4edge_client-1.0.5.tar.gz
Algorithm Hash digest
SHA256 3836053d1bc96958ffc0b3b7c1df815af322ddb486963381d4f0a06757f04e2f
MD5 70b95db3423a354c7c0a4f7422d90e83
BLAKE2b-256 376c9fc3c0234efb0306bf97aecc70595e90b5c0a9d9a3ef81f489d371140fdf

See more details on using hashes here.

File details

Details for the file io4edge_client-1.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for io4edge_client-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6189cec83a624123a647a5f918e821b9243c0f4042a58545b4d49a370084b506
MD5 7e2d3eb988f0d25d95f223304eecd552
BLAKE2b-256 ee2e88f128acb4b77bf729db719de8a9813147fdc299f0ed77ae7f77150ae2bc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page