Skip to content

ledimestari/homeassistant-storj-integration

Repository files navigation

Homeassistant Storj Node statistics

A custom homeassistant integration storj_node_statistics to read statistics from a storj storage node using json data provided by the node.

This integration is unofficial and not related to the official storj company at all.

Example card

image

This is somewhat the view I'm using, the graphs should get more interesting over time.

Setup

HACS (recommended)

Click the button below to install via HACS.

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

Manual

Copy the "homeassistant_storj_integration" directory into the "custom_components" directory of your homeassistant install.

Configuration

After installation, you'll be able to setup your device in the gui like this:

image

Setup is simple and only needs the IP-address (e.g. 192.168.1.123) and the port of your node server.

Default port 14002 provided as a default value.

Features

This integration only reads data and does not not provide any actionable switches.

Provided sensors:

  • Node ID
  • Wallet address
  • QUIC status
  • Uptime
  • Version number
  • Diskspace Total
  • Diskspace Used
  • Diskspace Trash
  • Diskspace Free
  • Average Disk Space Used This Month
  • Disk Use Percentage
  • Bandwidth used this month
  • Bandwidth Egress this month
  • Bandwidth Ingress this month
  • Estimated earning this month
  • Held back this month
  • Gross total this month
  • Average online score of all satellites

each sensor uses the first six characters of the Node ID as a prefix to the key value, e.g. sensor.abc123_disk_use_percentage.

Potential features missing for now:

  • Suspension, Audit and Online scores for each satellite separate
  • Total payout history
  • Disk space overused
  • Time since last contact
  • Current period (Current month)

Backend

This integration uses the api endpoints provided by your storj node, you can find the used json formatted data from the paths below.

Used api paths:

http://<node ip address>:14002/api/sno/
http://<node ip address>:14002/api/sno/estimated-payout
http://<node ip address>:14002/api/sno/satellites

About

Add sensors to home assistant to monitor statistics of a storj node

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages