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:

  • io4edge management functions, such as firmware update
  • Analog In TypeA - IOU01, MIO01
  • Analog In TypeB - IOU09, MIO09
  • Binary IO TypeA - IOU01, MIO01
  • CAN Layer2 - IOU03, MIO03, IOU04, MIO04, IOU06
  • MVB Sniffer - IOU03, MIO03
  • Binary IO TypeB - IOU06, EKF SQ1, EKF SQ3
  • Binary IO TypeC - IOU07
  • Bitbus Sniffer - IOU13
  • Digiwave - IOU13
  • Binary IO TypeD - EKF SQ1
  • Pixel Display - EKF SQ3
  • Color LED - EKF Z1010
  • Watchdog - EKF Z1010

Currently not supported, but will follow:

  • Motion Sensor - CPU01UC

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>

Releasing

To release a new version of the package, follow these steps:

  1. Update the version number in io4edge-client/version.py.
  2. Create a new git tag with the same version number, e.g. git tag v1.0.0.
  3. Push the tag to the remote repository: git push --tags.

Copyright

Copyright © 2021-2025 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-2.0.2.tar.gz (34.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

io4edge_client-2.0.2-py3-none-any.whl (67.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: io4edge_client-2.0.2.tar.gz
  • Upload date:
  • Size: 34.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for io4edge_client-2.0.2.tar.gz
Algorithm Hash digest
SHA256 da85cbb459fc0c851bf7b081f39c5e7bdef252f1d9e484a69e8710dec05ee25f
MD5 0e19d507d470ef3b57aabee4a53433c6
BLAKE2b-256 156e1954864d415757dfc172082868f9288225f4ca7f4dac5d65041504c2c2fe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: io4edge_client-2.0.2-py3-none-any.whl
  • Upload date:
  • Size: 67.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for io4edge_client-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 35989e43a6cab0497f0862c83e9d142d1928f38b83ec4bbeddeddcb1d8b8070f
MD5 26891744766a16a3ec1c9e0a135f4442
BLAKE2b-256 c2b0d06b650e7b9963596af47e25bc08bf2ed18d7f5742bd4f8e96f9014e89de

See more details on using hashes here.

Supported by

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