echonet

The uecho-rs is a portable, cross-platform development framework for Rust developers to create ECHONET-Lite controller and device applications. ECHONET-Lite is an open standard specification for IoT devices in Japan, it specifies more than 100 IoT devices such as crime prevention sensors, air conditioners and refrigerators.

What is uEcho ?

The uecho-rs is a comprehensive framework for ECHONET-Lite development in Rust. To implement IoT controllers or devices of ECHONET-Lite, the developer had to understand and implement the communication middleware specification such as the message format and base sequences.

The uecho-rs provides the following major components to control ECHONET-Lite devices and create the standard ECHONET-Lite devices easily without in-depth ECHONET-Lite specification understanding.

• ECHONET-Lite controller to find and control ECHONET-Lite nodes.
• ECHONET-Lite device framework to implement any standard ECHONET-Lite devices.
• Decoder and Encoder for ECHONET-Lite messaging packet.
• Standard device database based on Machine Readable Appendix and Manufacturer code List provided by the ECHONET Consortium.

The uecho-rs handles all ECHONET-Lite requests such as read, write and notification requests automatically. Therefore, Rust developers can implement the standard device and controller applications using the uecho-rs easily by simply implementing the request message validators.

Getting Started

To add the uecho-rs to your project, add the following to your Cargo.toml file:

[dependencies]
echonet = "1.x.x"

no_std support:

[dependencies]
echonet = { version = "1.x.x", features = ["no_std"] }

The examples are available for ECHONET-Lite controller and device implementations using the uecho-rs, check out the examples folder in GitHub.

Table of Contents

• Controller
  • Overview of Controller
• Device
  • Overview of Device
  • Inside of Device
• Examples
  • Usage examples
  • Usage examples (For Raspberry Pi Sense HAT)

Getting Help

• crates.io: Rust Package Registry - echonet(latest version)
• Generated Docs (latest version)

License

This project is licensed under the Apache-2.0 License.