Actions77
- Accessory Actions
- Authentication Actions
- Backup & Restore Actions
- Config Editor Actions
- Platform Tool Actions
- Plugin Actions
- Server Actions
- Restart Server
- Restart Child Bridge
- Stop Child Bridge
- Start Child Bridge
- Get Pairing Info
- Reset Homebridge Accessory
- Reset Cached Accessories
- Get Cached Accessories
- Delete Cached Accessories
- Delete Cached Accessory
- Get Device Pairings
- Get Device Pairing
- Delete Device Pairing
- Get Unused Port
- Get Network Interfaces
- Get Bridge Network Interfaces
- Set Bridge Network Interfaces
- Setup Wizard Actions
- Status Actions
- User Actions
Overview
This node integrates with the Homebridge API, allowing users to manage various aspects of their Homebridge setup. Specifically, for the "Plugin" resource and the "Get Config Schema" operation, the node retrieves the configuration schema of a specified Homebridge plugin. This is useful for users who want to programmatically access the configuration options available for a plugin, enabling dynamic configuration or validation in automation workflows.
Practical examples include:
- Automatically fetching the latest configuration schema for a plugin before applying settings.
- Validating user input against the plugin's config schema in a larger automation process.
- Integrating plugin configuration management into CI/CD pipelines for Homebridge setups.
Properties
| Name | Meaning |
|---|---|
| Access Token | An access token obtained from a prior login operation or entered manually for authentication. |
| Plugin Name | The exact name of the Homebridge plugin whose configuration schema you want to retrieve. |
Output
The node outputs JSON data representing the configuration schema of the specified plugin. This schema typically includes details about configurable properties, their types, default values, constraints, and descriptions. This structured output can be used downstream in workflows to dynamically generate UI forms or validate configurations.
No binary data output is indicated for this operation.
Dependencies
- Requires an active connection to a Homebridge server API.
- Needs an API authentication token (access token) either from a previous login node or manual entry.
- The node expects the Homebridge server URL to be configured in credentials or environment variables.
Troubleshooting
- Invalid or missing access token: Ensure that the access token is correctly provided either via a connected login node or manual input. Authentication failures will prevent schema retrieval.
- Incorrect plugin name: Verify the plugin name matches exactly as registered in Homebridge; otherwise, the API may return errors or empty results.
- Network connectivity issues: Confirm that the Homebridge server URL is reachable and correct.
- API changes or version mismatches: If the Homebridge API changes, the node might fail to parse responses correctly. Check for updates to the node or Homebridge server.
Links and References
- Homebridge Official Website
- Homebridge API Documentation (if publicly available)
- n8n Documentation on Creating Custom Nodes