Connectors & plug-and-play ingest

Pair gateways and meters to FreeMaint, ingest readings via API key, and send control commands

6 min read

Connectors link your physical meters and gateways to FreeMaint so readings flow in automatically and commands can flow back out. The pairing model is designed to be plug-and-play with common hardware.

Pairing a connector

Pair a connector to generate an API key. The key is shown only once, so copy it immediately and store it securely โ€” you can always rotate it later if needed.

Ingesting readings

Point your gateway at FreeMaint to push readings in automatically.

  • Have your gateway POST readings to /api/v1/energy/ingest using the API key as a Bearer token.
  • Typical hardware includes a Shelly Pro 3EM with relays, or a Home Assistant / Node-RED bridge.
  • Map each physical meter to a FreeMaint meter using its external ID, so every reading lands on the right meter.

Control over connectors

To send commands back to your equipment, register the connector's command endpoint (an HTTPS URL). FreeMaint then sends signed commands to that endpoint, so the connector can trust and execute them.

Status and key rotation

Each connector card shows its current connection status. You can rotate the API key at any time โ€” useful if a key may have been exposed or as part of routine security hygiene.

Was this page helpful?