Git Product home page Git Product logo

shlley-fleet-management's Introduction

Fleet Management

Fleet Manager is a standalone software service for controlling and monitoring a fleet of second generation Shelly devices. Fleet Manager exposes a websocket server endpoint on which Shelly Plus and Pro series devices can connect to using their outbound websockets. Once connected they can be fully managed by Fleet Manager. Fleet Manager also exposes a websocket endpoint for clients to connect to. Messages send to Fleet Manager must follow the JSON-RPC 2.0 protocol. Communication protocols for Fleet Management are described in RPC and Components

Useful resources

  1. RPC and Components
  2. Events
  3. RPC Relay
  4. Plugins
  5. Codebase
  6. Developing

Connecting a Shelly device

To connect a second generation Shelly device do the following:

  1. Open the Shelly device's local webpage
  2. Navigate to Networks -> Outbound websocket
  3. Click the toggle button that enables the outbound websocket and enter the address of the fleet management server followed by /shelly (hint: ws://<your ip>:7011/shelly).

After that the device should show up in the home page of the application.

Codebase

The codebase is split into modules - backend and frontend. They are described in the Codebase section.

Start the program

Using docker:

docker compose up --build -d 

Other ways

Other ways of starting the program are described in Developing.

Contributing

Contributing can be done with pull requests in Github.

shlley-fleet-management's People

Contributors

comboro avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.