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 interacts with the Homebridge API, specifically providing platform-specific operations. The "Set HB Service Settings" operation allows users to configure startup settings for the Homebridge service. This is useful for customizing the behavior of the Homebridge server environment, such as enabling debug modes, setting environment variables, or toggling security options.
Practical examples include:
- Enabling debug mode to troubleshoot issues.
- Setting environment variables to customize Node.js runtime options.
- Configuring the service to run in insecure mode during development.
- Managing orphaned accessories behavior on startup.
Properties
| Name | Meaning |
|---|---|
| Access Token | Access token obtained from a prior login operation or entered manually for authentication. |
| Startup Settings | A collection of key-value pairs to configure Homebridge startup environment: |
| - Debug Environment (string): Custom debug environment variable. | |
| - Debug Mode (boolean): Enable or disable debug mode. | |
| - Insecure Mode (boolean): Enable or disable insecure mode (less strict security). | |
| - Keep Orphans (boolean): Whether to keep orphaned accessories on startup. | |
| - Node Options (string): Additional Node.js options to pass at startup. |
Output
The node outputs JSON data representing the response from the Homebridge API after applying the startup settings. This typically includes confirmation of the updated settings or any error messages returned by the API.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating with the Homebridge server.
- The node expects the base URL of the Homebridge server to be configured in the credentials.
- The user must provide a valid access token either from a previous login operation or manually.
Troubleshooting
- Invalid Access Token: If the access token is missing or invalid, the API call will fail. Ensure the token is correctly provided.
- Incorrect Startup Settings Format: The startup settings must be provided as a collection with correct keys and value types; otherwise, the API may reject the request.
- Connection Issues: Verify that the Homebridge server URL is reachable and the API endpoint is accessible.
- Permission Denied: The API key used must have sufficient permissions to modify service settings.