Skip to main content

Python client 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. Create a new git tag with a version number, e.g. git tag v1.0.0.
  2. Push the tag to the remote repository: git push --tags.

Copyright

Copyright © 2021-2026 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.6.2.dev0.tar.gz (98.6 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.6.2.dev0-py3-none-any.whl (117.3 kB view details)

Uploaded Python 3

File details

Details for the file io4edge_client-2.6.2.dev0.tar.gz.

File metadata

  • Download URL: io4edge_client-2.6.2.dev0.tar.gz
  • Upload date:
  • Size: 98.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for io4edge_client-2.6.2.dev0.tar.gz
Algorithm Hash digest
SHA256 a1a324be965c8205d87651e4b17eb0907e8a40009fcee255fc63deef3813fbe8
MD5 7bcf8db3c6a81339df27cc005233284a
BLAKE2b-256 c716b128db1104f9ba3b214507a91a0332a6558c11d35cd74e708ebfec903c68

See more details on using hashes here.

File details

Details for the file io4edge_client-2.6.2.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for io4edge_client-2.6.2.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 086246a0614dd59236b0c9a82cddc6aa23eb36089bd3563d6c624338181617d9
MD5 0afd8cc0b85b4153ce8f55403295bc9f
BLAKE2b-256 aae2b8f1c9c3566f7835c15b33c982fe716d1f151f91856c6a6d4f697331e377

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