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.1.0.tar.gz (22.4 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for io4edge_client-1.1.0.tar.gz
Algorithm Hash digest
SHA256 97a1d3644283d9c10a47a2770c9d40a727d9cfa07a14f39f7de5e0796e2dde9a
MD5 8bb9974f4c46a042a427cf9d58d4f74f
BLAKE2b-256 9ae51f888067f1e0addb9470836a0f30548ab2f0efe63c062253dd06c7b84dc4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for io4edge_client-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 357d5f5551aca2a2b68f0fc654835eb8dbc66de33a17410f230ad212261a5c0b
MD5 06691e2a787a944a91807b025afb04e1
BLAKE2b-256 ac283489a221128865c0b577214581d653f1af194809630a81f9e15b37143b25

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