homebridge-discord-occupancy-sensor

Homebridge plugin that provides occupancy sensors based on Discord user presence.

Requirements

• Node.js version 14 or higher
• Homebridge version 1.3.0 or higher

Check your Node.js and Homebridge versions with node -v and homebridge -V respectively, and update as needed.

Installation

This plugin can be installed and configured through the Homebridge UI or the command line.

Install via Homebridge UI

1. Open the Homebridge UI
2. Navigate to the Plugins tab
3. Search for "discord occupancy sensor"
4. Click Install

Install via Command Line

1. Install Homebridge: sudo npm install -g homebridge --unsafe-perm
2. Install this plugin: sudo npm install -g homebridge-discord-occupancy-sensor
3. Update your Homebridge configuration file. See config-sample.json in this repository for a sample.

Configuration

This plugin requires a Discord bot token to access your Discord server. You can obtain a bot token by following the instructions in the Discord Developer Portal.

Configuration File Example

{
  "platforms": [
    {
      "platform": "DiscordOccupancySensor",
      "name": "My Server",
      "token": "your-bot-token",
      "channelIDs": ["123456789012345678", "234567890123456789"],
      "debug": false
    }
  ]
}

Configurations Table

| Parameter | Description | Default | Type | |-------------|---------------------------------------------------------------------------------------------------------------------------|---------|---------------| | platform | Always "DiscordOccupancySensor". | - | String | | name | Name of the platform, displayed in the Homebridge logs. | - | String | | token | Discord bot token to access your Discord server. | - | String | | channelIDs | Array of Discord channel IDs to monitor for user activity. | - | Array of IDs | | debug | Whether to enable debug logging. If enabled, the plugin will log more information to the console. | false | Boolean |

Troubleshooting

If you encounter any issues with this plugin, check the Homebridge logs first for error messages.

If you need further assistance, feel free to open an issue or ask for help in the Homebridge Discord server.

Contributing

Contributions are welcome! Please refer to the contributing guidelines for more information.

License

MIT