Skip to content

Installation & Setup

Prerequisites

  • Home Assistant 2024.1 or later
  • Access to the Felicity Cloud (shine.felicitysolar.com)

Installation

  1. Download the release ZIP felicity_energy.zip from Releases.
  2. Unzip so that this path exists:
<HA config>/custom_components/felicity_energy/manifest.json
  1. Restart Home Assistant.
  2. Settings → Devices & Services → Add Integration → "Felicity Energy".

Setup

Demo mode

  1. Add integration.
  2. Choose Demo mode → OK.

Nine sensors with simulated values are created immediately.

Felicity Cloud token

  1. Open https://shine.felicitysolar.com and log in.
  2. Open browser DevTools → Network → open any API request (e.g. get_energy_flow2).
  3. Copy the Authorization header value (starts with Bearer_).
  4. Add integration → choose Felicity Cloud access token → paste token → OK.

Token lifetime: ~30 days. When it expires, HA automatically starts the reauth flow. No password is stored.

After setup

  • Nine sensors are immediately available.
  • A dashboard appears automatically in the sidebar.
  • The sensors can be used in the Energy Dashboard.