pca9956b-api

pca9956b-api is an HTTP RESTful API designed to control a PCA9956B IC. This repo includes: - An API specification in OpenAPI format. - Skeleton client and server implementations in Rust.

A fully-featured server implementation for Linux, in Rust, can be found at https://github.com/packom/pca9956b.

The text below was automatically generated by the openapi-generator.

Rust API for openapi_client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This client/server was generated by the [openapi-generator] (https://openapi-generator.tech) project. By using the OpenAPI-Spec from a remote server, you can easily generate a server stub.

To see how to make this your own, look here:

README

This autogenerated project defines an API crate openapi_client which contains: * An Api trait defining the API in Rust. * Data types representing the underlying data model. * A Client type which implements Api and issues HTTP requests for each operation. * A router which accepts HTTP requests and invokes the appropriate Api method for each operation.

It also contains an example server and client which make use of openapi_client:

You can use the example server and client as a basis for your own code. See below for more detail on implementing a server.

Examples

Run examples with:

cargo run --example <example-name>

To pass in arguments to the examples, put them after --, for example:

cargo run --example client -- --help

Running the example server

To run the server, follow these simple steps:

cargo run --example server

Running the example client

To run a client, follow one of the following simple steps:

cargo run --example client ClearError cargo run --example client GetAddrEnabled cargo run --example client GetAddrInfo cargo run --example client GetAddrValue cargo run --example client GetApi cargo run --example client GetConfig cargo run --example client GetCurrent cargo run --example client GetError cargo run --example client GetErrors cargo run --example client GetFreq cargo run --example client GetGroup cargo run --example client GetLedCurrent cargo run --example client GetLedError cargo run --example client GetLedInfo cargo run --example client GetLedInfoAll cargo run --example client GetLedPwm cargo run --example client GetLedState cargo run --example client GetOffset cargo run --example client GetOutputChange cargo run --example client GetOverTemp cargo run --example client GetPwm cargo run --example client GetSleep cargo run --example client Reset cargo run --example client SetAddrEnabled cargo run --example client SetAddrValue cargo run --example client SetCurrent cargo run --example client SetFreq cargo run --example client SetLedCurrent cargo run --example client SetLedPwm cargo run --example client SetOffset cargo run --example client SetPwm cargo run --example client SetSleep

HTTPS

The examples can be run in HTTPS mode by passing in the flag --https, for example:

cargo run --example server -- --https

This will use the keys/certificates from the examples directory. Note that the server chain is signed with CN=localhost.

Using the generated library

The generated library has a few optional features that can be activated through Cargo.

See https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section for how to use features in your Cargo.toml.

Documentation for API Endpoints

All URIs are relative to http://localhost

Method | HTTP request | Description ------------- | ------------- | ------------- clearerror | POST /pca9956b/{busId}/{addr}/error/clear | getaddrenabled | GET /pca9956b/{busId}/{addr}/addr/{num}/enabled | getaddrinfo | GET /pca9956b/{busId}/{addr}/addr/{num} | getaddrvalue | GET /pca9956b/{busId}/{addr}/addr/{num}/addr | getapi | GET /pca9956b/api | getconfig | GET /pca9956b/{busId}/{addr}/config | getcurrent | GET /pca9956b/{busId}/{addr}/current | geterror | GET /pca9956b/{busId}/{addr}/error | geterrors | POST /pca9956b/{busId}/{addr}/errors | getfreq | GET /pca9956b/{busId}/{addr}/freq | getgroup | GET /pca9956b/{busId}/{addr}/group | getledcurrent | GET /pca9956b/{busId}/{addr}/led/{led}/current | getlederror | GET /pca9956b/{busId}/{addr}/led/{led}/error | getledinfo | GET /pca9956b/{busId}/{addr}/led/{led} | getledinfoall | GET /pca9956b/{busId}/{addr}/led | getledpwm | GET /pca9956b/{busId}/{addr}/led/{led}/pwm | getledstate | GET /pca9956b/{busId}/{addr}/led/{led}/state | getoffset | GET /pca9956b/{busId}/{addr}/offset | getoutputchange | GET /pca9956b/{busId}/{addr}/outputChange | getovertemp | GET /pca9956b/{busId}/{addr}/overTemp | getpwm | GET /pca9956b/{busId}/{addr}/pwm | getsleep | GET /pca9956b/{busId}/{addr}/sleep | reset | POST /pca9956b/{busId}/reset | setaddrenabled | POST /pca9956b/{busId}/{addr}/addr/{num}/enabled/{enabled} | setaddrvalue | POST /pca9956b/{busId}/{addr}/addr/{num}/addr/{addrVal} | setconfig | POST /pca9956b/{busId}/{addr}/config | setcurrent | POST /pca9956b/{busId}/{addr}/current/{current} | setfreq | POST /pca9956b/{busId}/{addr}/freq/{freq} | setgroup | POST /pca9956b/{busId}/{addr}/group/{group} | setledcurrent | POST /pca9956b/{busId}/{addr}/led/{led}/current/{current} | setlederror | POST /pca9956b/{busId}/{addr}/led/{led}/error/{error} | setledinfo | POST /pca9956b/{busId}/{addr}/led/{led} | setledinfoall | POST /pca9956b/{busId}/{addr}/led | setledpwm | POST /pca9956b/{busId}/{addr}/led/{led}/pwm/{pwm} | setledstate | POST /pca9956b/{busId}/{addr}/led/{led}/state/{state} | setoffset | POST /pca9956b/{busId}/{addr}/offset/{offset} | setoutputchange | POST /pca9956b/{busId}/{addr}/outputChange/{outputChange} | setpwm | POST /pca9956b/{busId}/{addr}/pwm/{pwm} | setsleep | POST /pca9956b/{busId}/{addr}/sleep/{sleep} |

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author