nagyrobi / home-assistant-custom-components-pfsense-gateways

Monitor and react on your pfSense gateway's status with Home Assistant.

Note: this plugin is unsupported. Use https://github.com/travisghansen/hass-pfsense instead, which supports much more features, including gateway status.

Gateways status for pfSense

Support for pfSense gateways status monitoring using alexpmorris / pfsense-status-gateways-json script. Check https://github.com/alexpmorris/pfsense-status-gateways-json on how to install it on pfSense.

Returns True or False depending on the status of the gateway. Useful to trigger an external reboot or power-cycle of the ISP modem, or similar.

Example config

sensor:
- platform: pfsense_gateways
  host: 192.168.1.1
  name: pfSense gateway
  key: pfsense
  monitored_gateway_interfaces:
    - wan
    - opt2

Example automations

- alias: "pfSense GW-Down"
  trigger:
    - platform: state
      entity_id: sensor.pfsense_gateway_gw_wan1
      to: 'False'
  action:
    - service: notify.me
      data:
        message: "My internet just died"

- alias: "pfSense GW-Down 5min"
  trigger:
    - platform: state
      entity_id: sensor.pfsense_gateway_gw_wan1
      to: 'False'
      for:
        minutes: 5
  action:
    - service: notify.me
      data:
        message: "My internet just died more than 5 minutes ago, rebooting ISP crap"
    - service: switch.turn_on
      entity_id: switch.relay_powercycle_modem

Support forum: https://community.home-assistant.io/t/pfsense-stat-monitor/61070/55

home-assistant-custom-components-pfsense-gateways's Issues

Please add version to manifest.json

New requirements for custom components.

2021-03-01 12:28:49 WARNING (MainThread) [homeassistant.loader] No 'version' key in the manifest file for custom integration 'pfsense_gateways'. This will not be allowed in a future version of Home Assistant. Please report this to the maintainer of 'pfsense_gateways'

Make port and protocol configurable

The current version works only with http on default 80 port.
Sensor.py contains the following url format:
DEFAULT_RESOURCE = "http://{0}/status_gateways_json.php?key={1}"

Ii would be nice if protocol and port can be configured from HA sensor yaml, like:

sensor:
- platform: pfsense_gateways
  host: 192.168.1.1
  port: 9500
  ssl: true
  name: pfSense gateway
  key: pfsense
  monitored_gateway_interfaces:
    - wan
    - opt2

How do you specify a different port and HTTPS

Can you clarify how you would configure this? I am having an issue even after modifying the sensor.py

Need a couple floatval()s in JSON coming back from pfSense

I had trouble getting the linecharts to appear properly on the sensor cards for ping and loss. After looking at it and thinking on it for a while, I realized the issue is that we're getting units (mS, %) in the value returned in the JSON, and thus into Home Assistant. They're actually displaying as (for example) "9.857mS mS".

By putting a floatval() around both ping and loss values in the pfSense-side .php, I now get numbers coming across rather than the strings, and the pretty lines draw across the bottom of my sensor cards.

The appropriate place to fix this is likely on the Home Assistant side. I'd make a similar change in the component, but I'm not familiar enough myself with Home Assistant development to validate the change. If I did, this would be a PR, not an issue.

HTTPS Support

Hi, my pfSense is on https. If i use http://pfSenseIP/status_gateways_json.php?key=pfsense I get routed to https but displayed with 503 error. if I use https://pfSenseHOSTNAME/status_gateways_json.php?key=pfsense I get json output in the browser but not in HomeAssistant