Firewalla Local

About

Description from ccpk1/firewalla-local-ha

Supports

• Works locallyTalks to your devices on your own network. No vendor cloud in between.
• From the MarketplaceInstalled through the Marketplace, formerly HACS.
• Actively maintainedIts author released or pushed a change in the last six months.

Provides

• Switches
• Sensors
• Presence

Setting it up

Install it from the Marketplace and restart Home Assistant, then add it under Settings, Devices and services.

Texts from the code of ccpk1/firewalla-local-ha.

Entities

• Binary sensorsAlarm active, System Status, AP Status
• ButtonsSync runtime
• PresencePresence
• SensorsActive alarms, Speed test download, Speed test upload, Speed test latency, Ping latency, Ping packet loss, Usage

Actions

• Get alarmsReturn the newest active alarms and optionally archived alarms with normalized details and shared report metadata. Each alarm carries its own exception_id; the full silence-exception table is only included when requested.
  • Limit
  • Include archived
  • Refresh
  • Alarm type
  • Include silence records
  • Fetch detail
  • Config entry ID (Optional)
  • Config entry name (Optional)
• Get rulesReturn the current live policy rules as a flat, selectable list with rule id, action, enabled and paused state, target, scope, and any originating alarm. Use this to resolve the rule target for pause_rule and resume_rule.
  • Config entry ID (Optional)
  • Config entry name (Optional)
  • Enabled
  • Action
  • Target type
  • Applies to
  • Include purpose
  • Include system-managed
  • Alarm ID
• Get system overviewReturn a curated system summary: appliance health, the networks with per-network device counts, and counts for devices, VPN peers, groups, users, rules, and alarms, plus per-WAN speed-test and quality metrics. Counts and identities only, never record collections. Use include to add the group and user names and ids that other services accept as selectors.
  • Include
  • Config entry ID (Optional)
  • Config entry name (Optional)
• Sync runtimePoll the Firewalla box now and report when the snapshot was taken. Requests within the coordinator's debounce window are coalesced, so calling this alongside other actions still costs at most one poll.
  • Config entry ID (Optional)
  • Config entry name (Optional)
• Create ruleCreate a persistent block rule, optionally scoped to an alarm's target. Blocking a target from an alarm creates an ordinary policy rule that records the alarm id as a back-reference.
  • Alarm ID
  • Target type
  • Target value
  • Config entry ID (Optional)
  • Config entry name (Optional)
  • Host MAC
  • Host name
  • Group ID
  • Group name
  • User ID
• Archive alarmsMove one alarm or the whole active set to the archive. Archived alarms remain retrievable.
  • Alarm ID (Optional)
  • Alarm status (Optional)
  • Config entry ID (Optional)
  • Config entry name (Optional)
• Delete alarmsPermanently delete one alarm or a whole set. This cannot be undone.
  • Alarm ID (Optional)
  • Alarm status (Optional)
  • Confirm permanent deletion
  • Config entry ID (Optional)
  • Config entry name (Optional)
• Mute alarmCreate a scoped silence for an alarm type, domain, or IP address.
  • Alarm ID (Optional)
  • Alarm target type
  • Alarm target value (Optional)
  • Duration
  • Config entry ID (Optional)
  • Config entry name (Optional)
  • Host MAC
  • Host name
  • Group ID
  • Group name
• Unmute alarmRemove a silence by exception ID or an alarm-linked silence by alarm ID. Provide exactly one identifier.
  • Alarm ID (Optional)
  • Exception ID (Optional)
  • Config entry ID (Optional)
  • Config entry name (Optional)
• Delete rulePermanently delete one live policy rule, including a rule created by an alarm block action.
  • Rule ID
  • Confirm deletion
  • Config entry ID (Optional)
  • Config entry name (Optional)
• Get hostsReturn the Firewalla host (device) records with naming fields, IP address, device type, kind, group membership, and online state. Filters narrow the result on the box. Non-admin; for the full runtime inventory use get_runtime_inventory.
  • Detail
  • Host name
  • Host MAC
  • Group name
  • Kind
  • Network UUID
  • Online
  • User ID
  • Refresh first
  • Config entry ID (Optional)
• Get rule and runtime inventoryReturn the current Firewalla rule, group, user, and related runtime inventory as structured data plus a markdown summary.
  • Config entry ID (Optional)
  • Config entry name (Optional)
• Get network segment reportReturn one configuration-oriented network segment report in the shared report envelope from the Firewalla local API.
  • Network UUID (Optional)
  • Network name (Optional)
  • Refresh first
  • Config entry ID (Optional)
  • Config entry name (Optional)
  • Include
• Get flow reportReturn one flow report for a device, group, or user in the shared report envelope from the Firewalla local API.
  • Host MAC
  • Host name
  • Group ID
  • Group name
  • User ID
  • User name
  • Window hours (Optional)
  • Detail (Optional)
  • Record count (Optional)
  • Fetch all records (Optional)
• Get network segment usageReturn one window-selected usage-oriented network segment report in the shared report envelope from the Firewalla local API. Totals in bytes over a window of at least 60 minutes; for the current per-host rate use get_live_throughput.
  • Network UUID (Optional)
  • Network name (Optional)
  • Window
  • Top N rankings
  • Include sections
  • Refresh first
  • Config entry ID (Optional)
  • Config entry name (Optional)
• Get speed test resultsReturn normalized Firewalla internet speed test results from the coordinator refresh path.
  • WAN UUID (Optional)
  • WAN name (Optional)
  • Result limit
  • Refresh first
  • Config entry ID (Optional)
  • Config entry name (Optional)
• Get internet quality reportReturn normalized Firewalla internet-quality samples (ping latency and packet loss) from the manager cache.
  • WAN UUID (Optional)
  • WAN name (Optional)
  • Sample limit
  • Refresh first
  • Config entry ID (Optional)
  • Config entry name (Optional)
• Get live throughputReturn live throughput in bytes per second, read from the box now. One host, one network, or every host, depending on the selectors given. A rate, not a total; for data volume over a window use get_network_usage. Network figures are that interface's counters and exclude same-segment traffic between hosts; host figures are complete.
  • Host MAC (Optional)
  • Host name (Optional)
  • Network UUID (Optional)
  • Network name (Optional)
  • Host limit
  • Sample window
  • Config entry ID (Optional)
  • Config entry name (Optional)
• Wake hostSend a Wake-on-LAN command to one Firewalla host.
  • Host MAC (Optional)
  • Host name (Optional)
  • Host ID (Optional)
  • Refresh first
  • Config entry ID (Optional)
  • Config entry name (Optional)
• Delete hostPermanently delete one or more Firewalla host devices identified by MAC.
  • Host MAC
  • Confirm
  • Refresh
  • Config entry ID (Optional)
  • Config entry name (Optional)

Troubleshooting

• DiagnosticsDownloads a diagnostics file to attach to a bug report.