diff --git a/scrutiny/README.md b/scrutiny/README.md index d37f6ba26..9f69f0d61 100644 --- a/scrutiny/README.md +++ b/scrutiny/README.md @@ -38,6 +38,40 @@ ssl: true/false (for Ingress) certfile: fullchain.pem #ssl certificate keyfile: privkey.pem #sslkeyfile ``` + +# Integration in home assistant +-------------- +Integration with HA can be done with the [rest platform](https://www.home-assistant.io/integrations/rest) in configuration.yaml. + +Two types of api endpoints are available: +- Summary data : http://YOURIP:ADDONPORT/api/summary +- Detailed data : http://YOURIP:ADDONPORT/api/WWN/details + +For the detailed data, wmn can be found for each hdd within the scrutiny app. For example for me : http://192.168.178.23:8086/api/device/0x50014ee606c14537/details + +Example to get data from the first hdd. + +```yaml +rest: + - verify_ssl: false + scan_interval: 60 + resource: http://YOURIP:ADDONPORT/api/summary + sensor: + - name: "HDD disk 1" + json_attributes_path: "$.data[0].smart_results[0]" + value_template: "OK" + json_attributes: + - "device_wwn" + - "date" + - "smart_status" + - "temp" + - "power_on_hours" + - "power_cycle_count" + - "ata_attributes" + - "nvme_attributes" + - "scsi_attributes" +``` + # Illustration -------------- ![](https://github.com/AnalogJ/scrutiny/raw/master/docs/dashboard.png)