Homebridge icon

Homebridge

Interact with Homebridge API

Actions77

Overview

This node integrates with the Homebridge API, specifically allowing users to interact with the Homebridge server and its connected child bridges. The "Get Device Pairing" operation under the "Server" resource retrieves pairing information for a specified child bridge device. This is useful in scenarios where you need to programmatically access or verify the pairing details of a Homebridge child device, such as when managing multiple bridges or automating device configurations.

Practical examples include:

  • Fetching pairing data to troubleshoot connection issues between Homebridge and HomeKit.
  • Automating the retrieval of device pairing info for inventory or audit purposes.
  • Integrating with other systems that require knowledge of paired devices on Homebridge.

Properties

Name Meaning
Access Token An access token obtained from a prior login operation. If not using the Login node, enter manually. It authenticates the request to the Homebridge API.
Device ID The unique identifier of the child bridge device whose pairing information you want to retrieve. This is required.

Output

The node outputs JSON data containing the pairing information of the specified child bridge device. This typically includes details such as pairing keys, identifiers, and possibly metadata about the device's connection status. The exact structure depends on the Homebridge API response but generally provides all necessary data to understand or manage the device's pairing state.

No binary data output is expected from this operation.

Dependencies

  • Requires an active Homebridge API endpoint accessible via a base URL configured in credentials.
  • Requires an API authentication token (access token) either provided by a preceding login operation or entered manually.
  • The node depends on the Homebridge API being available and reachable from the n8n environment.

Troubleshooting

  • Common Issues:

    • Invalid or missing access token will cause authentication failures.
    • Incorrect or non-existent device ID will result in errors or empty responses.
    • Network connectivity issues to the Homebridge server can prevent successful API calls.
  • Error Messages:

    • Authentication errors typically indicate invalid or expired tokens; re-authenticate or provide a valid token.
    • "Device not found" or similar messages suggest the device ID does not exist or is incorrect; verify the device ID.
    • Timeout or connection errors imply network problems; check server availability and network settings.

Links and References

Discussion