Skip to content

Services Reference

Senyo edited this page Jun 13, 2026 · 5 revisions

Humidity Intelligence Wiki

Services Reference

Humidity Intelligence services are available from Home Assistant Developer Tools -> Actions under the humidity_intelligence domain.

Use this page as a practical manual. The current repository services.yaml, runtime code, diagnostics, and release notes remain the source of truth for exact service schemas and behavior in a release.

Before You Run A Service

  1. Open Developer Tools -> Actions.
  2. Select a humidity_intelligence service.
  3. Fill the service data using the UI fields or YAML.
  4. Run the service.
  5. Verify the result in notifications, generated files, diagnostics, or the dashboard.

Notes:

  • entry_id is optional for most services.
  • When entry_id is omitted, HI uses all entries or the first valid entry according to that service's behavior.
  • File outputs are written into the Home Assistant config folder.
  • Native Home Assistant diagnostics are the preferred public GitHub support attachment.

Dashboard And Card Services

Service Use
create_dashboard Create a Lovelace dashboard from a rendered HI layout.
view_cards Export cards to a file and send a notification with the file path.
dump_cards Export generated card YAML for Manual dashboards.
refresh_ui Rebuild entity mapping and re-render dashboard YAML cards.

Export Manual Card YAML

service: humidity_intelligence.dump_cards
data:
  filename: humidity_intelligence_cards
  layout: v2_mobile

Omit layout to export all cached layouts. Supply a layout such as v2_mobile or v2_tablet when you only want one layout.

After changing options, output-detail visibility, optional card rows, or mappings, export fresh YAML and paste it into the relevant Manual card.

Create A Dashboard

service: humidity_intelligence.create_dashboard
data:
  layout: v2_mobile
  title: Humidity Intelligence
  url_path: humidity-intelligence

Refresh Rendered UI

service: humidity_intelligence.refresh_ui
data: {}

refresh_ui rebuilds mappings and rendered card output. HI can also run this shortly after Home Assistant startup when the startup refresh option is enabled.

See Generated Dashboards and Troubleshooting Generated UI.

Runtime Control Services

Service Use
pause_control Pause the automation engine for a set number of minutes.
resume_control Resume the automation engine by clearing the pause timer.
service: humidity_intelligence.pause_control
data:
  minutes: 60
service: humidity_intelligence.resume_control
data: {}

Use these when you intentionally want HI to stand down or return to normal operation. The reason panel and diagnostics are the best places to verify the current runtime state.

Alert Light Test Service

flash_lights runs visual alert behavior for testing configured lights.

service: humidity_intelligence.flash_lights
data:
  power_entity: switch.alert_power
  lights:
    - light.bathroom_alert
  color: [255, 0, 0]
  duration: 12
  flash_count: 8

Runtime humidity, mould, and condensation visual alert rules use the current release's configured repeat behavior. Carbon-monoxide emergency stays the highest-priority safety lane.

Diagnostics And Validation Services

Service Use
self_check Validate mappings, telemetry setup, drift-helper status, frontend dependency status, and local HI snapshot status.
v205_release_check Run a read-only release-validation support report.
dump_diagnostics Export fuller local diagnostics for maintainer/debug workflows.
service: humidity_intelligence.self_check
data: {}
service: humidity_intelligence.v205_release_check
data:
  write_test_exports: true
  filename: humidity_intelligence_v205_release_check.json

v205_release_check can verify generated-card visibility, cached layout coverage, placeholder sanity, card text sanity, configured entity availability, drift-helper status, optional frontend dependency status, and local HI snapshot status. With write_test_exports: true, it writes test card exports to confirm export scope behavior. It is a read-only validation support service for runtime outputs and configured entities.

service: humidity_intelligence.dump_diagnostics
data:
  filename: humidity_intelligence_diagnostics.json

Use native Home Assistant diagnostics for public GitHub issues first. Use dump_diagnostics for deeper local maintainer/debug workflows after reviewing the export.

See Diagnostics and Support Bundle and Release Validation for Users.

Local HI Snapshot Services

Service Use
create_local_backup Create a package-local HI snapshot for advanced validation and rollback preparation.
list_saved_versions List finalized local HI snapshots and invalid snapshot folders.
service: humidity_intelligence.create_local_backup
data:
  retain_count: 2
  max_total_bytes: 52428800
service: humidity_intelligence.list_saved_versions
data: {}

These snapshots are local to the Humidity Intelligence package. Home Assistant backups remain the right tool for whole-instance protection, and HACS continues to own HACS-managed updates.

Cleanup Service

purge_files removes generated HI artifacts such as cards, diagnostics, and self-check outputs, and attempts dashboard cleanup.

service: humidity_intelligence.purge_files
data: {}

Use dump_diagnostics first when you want a troubleshooting snapshot before cleanup.


Previous Next
UI Gallery HACS and Updates

Clone this wiki locally