Homebridge icon

Homebridge

Interact with Homebridge API

Actions77

Overview

This node integrates with the Homebridge API, specifically allowing users to manage the Homebridge server and its cached accessories. The "Delete Cached Accessories" operation under the "Server" resource enables users to remove cached accessory data from the Homebridge server. This is useful when accessories have changed or become stale, and you want to clear their cache to force a refresh or reset.

Practical examples include:

  • Clearing cached data for specific HomeKit accessories after configuration changes.
  • Troubleshooting accessory issues by deleting their cached state.
  • Managing accessory lifecycle programmatically in automation workflows.

Properties

Name Meaning
Access Token An access token obtained from a prior login operation or entered manually for authentication.
Accessories to Delete A collection of one or more accessories to delete from the cache. Each accessory requires:
• UUID: Unique identifier of the accessory.
• Cache File: Path to the cache file associated with the accessory.

Output

The node outputs JSON data representing the response from the Homebridge API after attempting to delete the specified cached accessories. The structure typically includes status information about the deletion operation.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to a Homebridge server API endpoint.
  • Needs an API access token for authentication, which can be provided via a previous login node or manually entered.
  • The node expects the Homebridge API base URL to be configured in credentials or environment variables.

Troubleshooting

  • Invalid or missing access token: The operation will fail if the access token is not provided or expired. Ensure the token is valid and refreshed as needed.
  • Incorrect UUID or cache file path: If the accessory identifiers are incorrect, the API may return errors or fail to delete the cache. Verify accessory details before running.
  • Network or connectivity issues: Failure to reach the Homebridge server will cause errors. Check network settings and server availability.
  • API permission errors: Insufficient permissions on the API key or token can prevent cache deletion. Confirm that the token has appropriate rights.

Common error messages might include authentication failures, 404 not found for accessories, or 400 bad request due to malformed input. Resolving these involves verifying credentials, accessory details, and request formatting.

Links and References

Discussion