NOSHP-Client

Crates.ioNOSHP-Client
lib.rsNOSHP-Client
version0.3.3
sourcesrc
created_at2024-01-24 11:52:43.701636
updated_at2024-03-22 10:50:50.849981
descriptionThe Client library for Nik's Open-source Smart Home Platform
homepage
repositoryhttps://github.com/niknik3610/IoT_Platform/tree/main
max_upload_size
id1112061
size29,370
NikHarnish (niknik3610)

documentation

README

Client Library for Nik's Open-source Smart Home Platform

This Rust library is meant as a resource to easily write code to interact with the NOSHP server. This is mainly meant for Smart-Home devices.

Important Links

Building

Add the library to your project using the crates.io link above. Then create your device, or view the documentation for an example device.

Once you're done, run the command:

cargo build -r

Then install any dependencies you are missing.

Running

To run the client library you will need to set the IP of your server. How you get this is up to you. I personally recommend setting a static IP for your server, that way you won't need to change this everytime this changes. However if you do not want to do this, the server IP is printed at server startup.

Remember, the server IP needs to be prefixed with "HTTP://", otherwise it will not work

Notes

  • At the moment you will need to have the protobuf compiler installed (instructions can be found here).
Commit count: 0

cargo fmt