2.5.0 • Published 1 year ago

homebridge-json-thermometer v2.5.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
1 year ago

Homebridge Json Thermometer

This is a fork of the http-json-thermometer by Jakubkuba9000 that allows:

  • complex json objects to be parsed
  • minimum and maximum values per thermostat to filter out noisy default values like occasional 999°C from DS18B20 sensors on a Shelly Uni

Installation

  1. Install Homebridge.
  2. Install this plugin: npm install -g homebridge-json-thermometer or through Homebridge UI by clicking the INSTALL buttton.
  3. Update your config.json file by clicking the SETTINGS button through Homebridge UI or manually. See the explanations and samples below.

Configuration

Configuration example

{
  "platform": "HttpJsonThermometer",
  "thermometers": [ {
    "thermometerName": "Terrarium thermometer",
    "httpRoute": "http://ipaddress/status/",
    "updateInterval": 60,
    "jsonPath": "temp",
    "calibration": 0.16,
    "minValue": -900,
    "maxValue": 900,
    "manufacturer": "Default-Manufacturer",
    "model": "Default-Model",
    "serial": "Default-Serial"
    } ]
}

Examples

For a simple json object, defining the first property name is enough.

{
  "tC": 22.94,                // path is "tC"
  "tF": 73.29                 // path is "tF"
}

For complex json objects, the js dot notation can be used as path:

{
  "ext_temperature": {
    "0": {
      "tC": 22.94,                // path is "ext_temperature[0].tC"
      "tF": 73.29                 // path is "ext_temperature[0].tF"
    }
  }
}

Core

KeyDescriptionDefault
platformMust be HttpJsonThermometerHttpJsonThermometer
thermometerNameThis will be the name of your thermometer that appears in the Home app. This must be unique.Terrarium thermometer
httpRouteThis must be a path to a JSON format that looks like this, for example:{ "temp": "24.88","temp2": "24.06","temp3": "23.75"}http://ipaddress/status/
updateIntervalInterval after which the values are updated.60
jsonPathThis must be the path of the response value in a JSON response.In the case above it could be temp or temp2 or temp3.temp

Additional options

KeyDescriptionDefault
calibrationOnly if you need to calibrate your thermometer. It will increase or decrease the value. For example if you need to decrease by 0,05 then -0,05 and if you need to increase by 0.6 then 0.600.00
manufacturerManufacturer of your thermometer.Default-Manufacturer
modelThermometer model.Default-Model
serialSerial number of your thermometer.Default-Serial

More thermometers

You can also have more than one thermometer. Simply click the button ADD TO THERMOMETERS in UI or add it manually like this:

{
	"platform": "HttpJsonThermometer",
	"thermometers": [
		{
			"thermometerName": "Terrarium thermometer",
			"httpRoute": "http://ipaddress/status/",
			"updateInterval": 60,
			"jsonPath": "temp",
			"calibration": 0.16,
			"manufacturer": "Default-Manufacturer",
			"model": "Default-Model",
			"serial": "Default-Serial"
		},
		{
			"thermometerName": "Kitchen thermometer",
			"httpRoute": "http://yourdomain.com/temp/",
			"updateInterval": 15,
			"jsonPath": "t1",
			"manufacturer": "yourdomain.com",
			"model": "WIFI_USB",
			"serial": "S3r14lNumb3r"
		},
		{
			"thermometerName": "Bathroom thermometer",
			"httpRoute": "http://192.168.1.155/temperature/",
			"updateInterval": 120,
			"jsonPath": "temperature"
		}
	]
}

HomeKit limitations

Unfortunately, HomeKit has the limitation that it rounds values to 0.5 °C. This can be solved by downloading the free Eve app or another similar app. These applications usually show a value accurate to one decimal place.

Credits