The u-os-hub-api repository contains multiple API specifications for the u-OS Data Hub.
A general explanation of what the u-OS Data Hub is can be found here.
In this repository, there is a release tag for each u-os release.
For example, to obtain all API specifications for u-OS version 2.3, the tag u-os-2.3 must be checked out.
Otherwise, the individual APIs adhere to semver. Older specifications can therefore continue to be used if the major version of the API has not changed.
The u-OS Data Hub Variable APIs are compared here.
In the Variable-NATS-API, NATS is used as the transport mechanism. FlatBuffers is used as the payload format.
To use the Variable-NATS-API, we recommend using the u-os-hub-client-rs library.
Alternatively, you can create your own library by directly using FlatBuffers and NATS libraries for your desired language.
All NATS subjects are documented in the corresponding AsyncAPI specification variable-nats-asyncapi.yaml.
The FlatBuffers messages and types are located in the flatbuffers directory.
FlatBuffers schemata are compiled into target source code via the flatc compiler.
The flatc compiler is not included in this repository, but can be downloaded from here.
For an example of how to use flatc, see the FlatBuffers documentation.
We use OpenAPI to describe the Variable-HTTP-API in the file variable-http-openapi.yaml.
For a more visual view of the API, you can view it inside u-OS or use any OpenAPI UI like Swagger UI.
You can use the OpenAPI Generator to generate a client library for your desired programming language. The OpenAPI Generator can be found here. For an example of how to use the OpenAPI Generator, see the OpenAPI Generator documentation.
The administration API is also described using OpenAPI in the file administration-openapi.yaml.
If you have any questions or need help, please visit the Weidmueller Support Center.
If you would like to contribute to the project, please take a look at our Contributing Guidelines.
This project is licensed under the MIT license.