Shelly Dashboard / Monitor for 1. / 2. / 3. generation devices
S-Central is a client (React) / server (nodejs) application to monitor and control your Shelly devices. The server collects all relevant information about your devices by using RPC calls and websocket connections. The client is a webapplication that makes monitoring and controlling your Shellies easy.
S-Central is cloudless. That means it makes you (sort of) independent from the Shelly Cloud Control Center.
The server must run in your local network and acts as a broker between your Shellies and the client application. The communication with the client is strictly websocket based.
S-Central supports English, Spanish and German.
- Dashboard
Informs you about connected Shellies, current and timelined consumption, running scripts, cloud connection. - Shellies
Get insights about KVS values, script status, Logs and websocket messages. Control your switches. Get notified when a script error occurs. - User
Enable additional users to log in to the appplication. - Blog
A simple interface to write internal articles or notes to be displayed on the landing page. - Webservices
An API to call essential functions, e.g. from within your scripts.
Managing many Shellies in a network is a challenge. The original Shelly Control app is a good choice. But it is cloudbased. Hence you need an internet connection to control your devices. S-Central needs only Wifi and your local network. It is Open Source and transparent. You are welcome to participate and enhance the features.
-
Prerequisites
Install nodejs. Normally it includes the NPM packet manager. I tested the system with nodejs 20.x. -
Server (Client included)
Download the server release and unzip it in a directory of your choice. E.g. /sb (Shelly Broker). Normally you run the server on a dedicated always-on-system. Like a NAS, a Rasberry or any other OS that can run nodejs. Navigate to that directory and type npm install. It might take a while untill all modules are downloaded. In the meantime you could...Configure your Shellies
Add the IP addresses and custom names of your Shellies to the file /sb/config/devices.json. An example is included.Configure the display of KVS values
In the file /sb/config/kvsdisplays.json you can map KVS values to display names for convenience. An example is included.Configure to your needs
It strongly recommended to change atleast the default values of password and secret in /sb/config/default.json. Also you need to configure IP addresses and ports.
Read the Configuration details below!
The settings you must / should change before the first run are marked with (!). -
Client
The server release includes the current client version. But if the client version gets updated, you might want to install the newer version.
Download the client release and unpack the content into the /sb/public folder.
- Linux: npm start / npm stop
- Windows: node shellybroker.js / CTRL-C
Thats it! Navigate your browser to [YOURSERVERIP]:3031 and log in with [email protected] and password undlos
This project needs your help! There are so many Shelly devices and up to now only one developer :-) There is a simple and a developer stylish way to support.
The simple way
Add images to the project. The project works with 1. / 2. and 3. generation Shelly devices. But it lacks images of all the available devices as I personally don't own all of them. The best way (as far as I know) to get your hands on a high quality image of a device is to log in at Shelly Control and download the image of a device that is not yet included in the sc/public/assets/images/devices folder. Mind the name of the file as it must fit the modelname.
The Developer way
Fork the whole Github project and start making pullrequests! Your welcome! As with the images I'm sure other devices (I don't own) have special switches, RPC commands, JSON formats etc... Let's enhance this software to support more devices for the sake of all Shelly users!
As of now the log outputs of a Shelly can not directly be associated with the script that produces them :-( So to get this working you need to preceed every output with the name of the Script. For example you may use a CONFIG Object like
const CONFIG = {
// 'MyScriptname' must match the real name of the script!
logPrefix: 'MyScriptname (#' + Shelly.getCurrentScriptId() + '): ',
verbose: true
}
and then a function like
//log with prefix to console if verbose
function log(to_log) {
if(CONFIG.verbose) {
console.log(CONFIG.logPrefix, to_log);
}
}
to output messages to the console prefixed by the script name.
The server must be restartet when
- You add / change / delete a device in /sb/config/devices.json
- You add / delete a script on a device
- you add / delete a KVS key
- you change server configuration values
because of performance reasons this information is only retrieved once.
File: /sb/config/devices.json
| Option | Value | Description |
|---|---|---|
| ip | xxx.xxx.xxx.xxx | IP Address of a Shelly Device. Please use fixed IPs |
| cname (!) | e.g. 'Floorlight' | Display name for the client |
| password | text | (optional) If the device is protected |
File: /sb/config/kvsdisplays.json
| Option | Value | Description |
|---|---|---|
| display (!) | the display name | Mapping the KVS key to a display name |
| style | 'color' | Style of the KVS value. Omit this to show the value itself |
File: /sb/config/default.json
| Option | Value | Description |
|---|---|---|
| HTTP server | ||
| host (!) | xxx.xxx.xxx.xxx | The IP address of the HTTP server (nodejs) |
| port | TCP Port | The TCP port of the HTTP server. Defaults to 3031 |
| UDP server | ||
| host (!) | xxx.xxx.xxx.xxx | The IP of the UDP server. Must be configured in the Shelly device |
| port | UDP Port | The UDP port of the UDP server. Defaults to 3031 |
| Websocket server | ||
| host (!) | xxx.xxx.xxx.xxx | The IP of the Websocket server |
| port | TCP Port | The TCP port of the Websocket server. Defaults to 3031 |
| ping-interval | nr. of seconds | Websocket keep-alive interval to check if the client is connected |
| unblock-interval | nr. of seconds | Security feature. After this time a blocked client is unblocked |
| messagelimit | number | Security feature. Number of allowed WS messages per minute |
| secret (!) | secret text | Security feature. Is exchanged between WS client and server |
| Shelly config | ||
| set-udp | true / false | If true, all shellies are configured to sent UDP Logs |
| set-ws | true / false | If true, all shellies send ws messages to the server |
| Database | ||
| standardpw (!) | text | Standard password for all created users |
| standardal | text | Standard alias for the admin user (Created on first run) |
| standardem | Standard email for the admin user (Created on first run) | |
| standardhome | 'dashboard / 'shellies' | Standard homepage for all created users |
File: /sb/public/index.html
| Option | Value | Description |
|---|---|---|
| WSURL (!) | ws://[IP]:[PORT] | Used in (VITE) DEV mode to connect to the Websocket server |
| WSSURL (!) | wss://[IP]:[PORT] | Used in (VITE) PROD mode to connect to the Websocket server. This can also be ws://[IP]:[PORT] |
| RECONNECT_DELAY | nr. of seconds | When loosing the ws connection to server, reconnect after... |
| RECONNECT_MAX | number | Number of reconnect attemps after loosing the connection |
| LANDING_PAGE | 'login' or 'blogs' | If 'blogs' and public blogs exist, they are shown directly |
The client is build using VITE. See package.json for the relevant scripts. The vite build command uses an env.private file. If you create that file next to env.release you can slimline the process by replacing the WSURL and WSSURL placeholders in the build index.html.
Client
It's always a good idea to check the browser console (CTRL-SHIFT-I). On a mobile phone (Android) there's a browser called Eruda that also has a console view.
Server
- Windows
The console log is visible in the terminal window from which you started the server. - Linux
The server comes with pm2 process management and there is a script to see the console logs which you can run with npm run logs
The following devices have been tested with S-Central:
| PM | Light | Other |
|---|---|---|
| Plus1PMMini | SHBDUO-1 | PlusI4 |
| Plus1PM | PlusRGBWPM | SHPLG-S |
| 1PMMini (Gen3) |
to the Minimal Dashbard project: Without it, things would have been much harder!