new-home-application 0.1.3

New Home iot application framework. Meant to build application for the New Home Core
Documentation

Pipeline Status creates.io

New Home application

The project "New Home" is in the middle of development. It aims to create a self hosted and easy-to-use and easy-to-develop solution for creating your own smart-home with the help of RaspberryPI(s) (Covered in this specific application framework project).

For the future it's planned to add Arduino/ESP (with WiFi) support as well.

The project will consists of 3 parts

  • The underlying, executive application (this here)
  • The Core (not started yet)
  • The Frontend, which will be used to control your devices

Although the Core is not even started yet (will probably be done in a couple days) this application part can already be used to call specific registered methods by a JSON string over a TCP socket.

// TODO: move project description/plan to its appropriate project

TODOs

  • Create a basic framework to expose methods
    • the methods should be callable from a string requests sent via a TCP socket
    • the methods should be able to return a value to the requesting side
    • the method handles a given request and return some kind of answer in form of a string
    • Arguments that were send are validated against the original method definition and its arguments
    • Some basic commands for application information and help

Usage

For an example, how to use the library, take a look into the "example/example-application.rs" also the tests may help you to find a starting point.

// TODO: Describe Usage

// TODO: Add documentation for usage