Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/filipnet/ups-json-publisher
UPS Data Publisher for MQTT: Capture UPS details using upsc, format as JSON, and send to MQTT broker.
https://github.com/filipnet/ups-json-publisher
grafana grafana-dashboard grafana-influxdb json mosquitto-pub mqtt mqtt-client nodered parser parsing shell-script ups upsc
Last synced: 11 days ago
JSON representation
UPS Data Publisher for MQTT: Capture UPS details using upsc, format as JSON, and send to MQTT broker.
- Host: GitHub
- URL: https://github.com/filipnet/ups-json-publisher
- Owner: filipnet
- License: bsd-3-clause
- Created: 2023-08-25T19:49:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-02T16:53:21.000Z (about 1 year ago)
- Last Synced: 2023-12-02T17:34:21.580Z (about 1 year ago)
- Topics: grafana, grafana-dashboard, grafana-influxdb, json, mosquitto-pub, mqtt, mqtt-client, nodered, parser, parsing, shell-script, ups, upsc
- Language: Shell
- Homepage:
- Size: 19.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ups-json-publisher
UPS Data Publisher for MQTT: Capture UPS details using upsc, format as JSON, and send to MQTT broker.
- [ups-json-publisher](#ups-json-publisher)
- [Usage](#usage)
- [Clone the Repository](#clone-the-repository)
- [Configure MQTT Broker Settings](#configure-mqtt-broker-settings)
- [Run the Script](#run-the-script)
- [Run the Script Periodically with Cron](#run-the-script-periodically-with-cron)
- [Node-RED transformation and InfluxDB import](#node-red-transformation-and-influxdb-import)
- [License](#license)
## Usage
### Clone the Repository
```
git clone https://github.com/filipnet/ups-json-publisher.git
cd ups-json-publisher
```
### Configure MQTT Broker Settings
Copy the example configuration file:
```
cp config.sh.example config.sh
```
Open config.sh in a text editor (e.g., nano, vim) and replace placeholders with your actual MQTT broker information.
### Run the Script
Make sure the required dependencies are installed: upsc (part of Network UPS Tools) and mosquitto_pub (part of Mosquitto MQTT client).
Run the script with the device name as an argument:
```
./mqtt_upsc_script.sh
```
Important: Protect Your Configuration:
The config.sh file contains sensitive information. Make sure not to expose your credentials by adding config.sh to the .gitignore file. Never commit the actual config.sh to the repository.
### Run the Script Periodically with Cron
To run the script periodically, you can add a line to the system-wide crontab file. Open the crontab configuration:
```
sudo vim /etc/crontab
```
Add the following line to run the script every 5 seconds, suppressing the script output:
```
*/5 * * * * /bin/timeout -s 2 1m /root/ups-json-publisher/mqtt_upsc_script.sh >/dev/null 2>&1
```
For shorter time intervals you can also use the helper-script "run_upsc_script.sh".
Replace with the actual name of your UPS device.
If the execution intervals are too short, the script may be restarted before the previous process has finished - which can lead to problems with system performance or the MQTT server. Therefore, always adjust the timeout in the cronjob to a value below the set execution interval.
- Mosquitto MQTT Client
## Node-RED transformation and InfluxDB import
If the scheduler and an MQTT input node have been configured, all data from the output of nutc should now arrive in the node-RED. Forwarding this data to InfluxDB is simple due to the JSON format. Since InfluxDB is a time series database it makes sense to pass the fields that have a numeric value to InfluxDB as a number and not as a string. For this I wrote a separate function.
Die Funktionion sieht dabei wie folgt aus:
```
// Node-RED Function Node
// Processes JSON input and returns a JSON differentiating between Strings and Numbers
var inputJSON = msg.payload;
function differentiateJSON(inputJSON) {
var outputJSON = {};
for (var key in inputJSON) {
if (/^-?\d*\.?\d+$/.test(inputJSON[key])) {
outputJSON[key] = parseFloat(inputJSON[key]); // Convert value to Number
} else {
outputJSON[key] = inputJSON[key];
}
}
return outputJSON;
}
var outputJSON = differentiateJSON(inputJSON);
msg.payload = outputJSON;
return msg;
```
To pass only certain values to InfluxDB, a downstream function node can be used that might look like this:
```
var inputJson = msg.payload; // Input JSON
// Select desired keys/values
/*
battery.charge = Battery charge (percent)
battery.runtime = Battery runtime (seconds)
ups.realpower = Current value of real power (Watts)
*/
var desiredKeys = ["battery.charge", "battery.runtime", "ups.realpower"]; // Specify the desired keys here
var outputJson = {};
for (var i = 0; i < desiredKeys.length; i++) {
var key = desiredKeys[i];
if (inputJson.hasOwnProperty(key)) {
outputJson[key] = inputJson[key];
}
}
msg.payload = outputJson; // Set the output
return msg;
```
## License
This project is licensed under the BSD 3-Clause License.