Orb score network reliablity and speed measurement [orbforge]

Just a nice one I spotted today GitHub - orbforge/addon-orb: Orb Sensor Home Assistant Addon

This one is special as you can turn any supported device into a montoring stats generator. Currently i installed on Synology as docker, but link shows it directly as add-on in HA.
The app supports a command that outputs a JSON with all info, which is easliy transformed into a RESTfull entity. On discord there is already talks on officlal HA integration and/or MQTT support directly.

docker exec orb-sensor /app/orb summary > here/your/path/b/orb/orbsensorout.json

exporting to JSON file, which for me ends up on an https adress to use in rest sensor as below

  - resource: https://youserverlocation/orb/orbsensorout.json
    scan_interval: 900
    sensor:
      - name: "ORB hour sensor Syno"
        unique_id: orbsensorsyno_score
        value_template: "{{ ((value_json.orb_scores.2.display | float(0)) if value_json is defined else 'unavailable')  }}"
      - name: "ORB hour sensor Syno bandwith up"
        unique_id: orbsensorsyno_upload
        value_template: "{{ ((value_json.orb_scores.2.components.bandwidth_score.components.upload_bandwidth_kbps.value | float(2)) if value_json is defined else 'unavailable')  }}"
      - name: "ORB hour sensor Syno bandwith down"
        unique_id: orbsensorsyno_download
        value_template: "{{ ((value_json.orb_scores.2.components.bandwidth_score.components.download_bandwidth_kbps.value | float(2)) if value_json is defined else 'unavailable')  }}"

2 Likes

The mqtt implementation is ready for HA. Interested if anyone has some experiences yet.

1 Like

I just stumbled upon this from another post related to the buggy speedtest.net integration.
I just installed the Orb add-on and Android app and I’m loving it so far.
This looks awesome and I just need to check the privacy and security around orb for my own sanity.

Can you provide a layman’s explanation of the mqtt interaction and benefit with orb?

it removes the need for a ‘native integration’ in HA. If the orb sensor pushes data to mqtt , HA will automatically create the sensors based on announce.
I just played with the json and dont think they have it served as API endpoint yet. So mqtt from the addin setup would help on ease of integrating

1 Like