![](\"https://raw.githubusercontent.com/mpatfield/homebridge-flume/refs/heads/latest/img/banner.png\")
\n\n\n
![](\"https://raw.githubusercontent.com/mpatfield/homebridge-flume/refs/heads/latest/img/screenshot_1.png\")
![](\"https://raw.githubusercontent.com/mpatfield/homebridge-flume/refs/heads/latest/img/screenshot_2.png\")
\n\nIf you use a more advanced HomeKit app like [Eve](https://apps.apple.com/us/app/eve-for-matter-homekit/id917695792) or [Controller for Homekit](https://apps.apple.com/us/app/controller-for-homekit/id1198176727), you will see some additional information about your water use. Unfortunately, Apple currently doesn't offer a way to display this in the Home app.\n\n![](\"https://raw.githubusercontent.com/mpatfield/homebridge-flume/refs/heads/latest/img/screenshot_3.png\")
\n\n## Configuration\n\nYou'll need to get your API Access Client ID and Client Secret from the [Flume portal](https://portal.flumetech.com).\n\n[This guide](https://flumetech.readme.io/reference/accessing-the-api) provides step-by-step instructions.\n\nUsing the Homebridge Config UI is the easiest way to set up this plugin. However, if you wish to do things manually then you will need to add the following to your Homebridge `config.json`:\n\n```json\n{\n \"name\": \"Flume\",\n \"platform\": \"Flume\",\n \"username\": \"[username]\",\n \"password\": \"[password]\",\n \"clientId\": \"1234567890ABCD\",\n \"clientSecret\": \"1234567890ABCDEFGHIJ\",\n \"refreshInterval\": 1,\n \"units\": \"GALLONS\",\n \"disableDeviceLogging\": false,\n \"verbose\": false,\n \"excludeDevices\": [\"1234567890\", \"9876543210\"]\n}\n```\n\n- `username` - (Required) Flume username\n- `password` - (Required) Flume password\n- `clientId`/`clientSecret` - (Required) Flume Client ID, found at [https://portal.flumetech.com](https://portal.flumetech.com)\n- `refreshInterval` - (Required) number of minutes between updates; must be `1` or more\n- `useNotifications` - (Optional) if true, an unread usage alert notification will be considered a leak\n - To clear leaks, mark notifications as `read` in the Flume app.\n- `units` - (Required) the type of units to use for custom characteristics\n- `disableDeviceLogging` - (Optional) if true, then accessory status changes will not be logged\n- `verbose` - (Optional) if true, there will be additional logging for debugging purposes\n- `excludeDevices` - (Optional) a list of devices to exclude; look for `Adding new device: [Device ID]` in the logs\n\n## Credits\n\n[@LexifOder](https://github.com/sponsors/LexifOder) for German translations\n\n[@dcompane](https://github.com/sponsors/dcompane) for Spanish translations\n\n[Keryan Belahcene](https://www.instagram.com/keryan.me) for creating the [Flume](https://github.com/homebridge-plugins/homebridge-flume) header logo\n\n[@bwp91](https://github.com/sponsors/bwp91) for creating and maintaining this plugin for years despite not even owning a Flume device\n\n@weallknowwhoisatfaulthere for earlier work done [homebridge-flume-water-sensor](https://www.npmjs.com/package/homebridge-flume-water-sensor)\n\nAnd to the amazing creators/contributors of [Homebridge](https://homebridge.io) who made this plugin possible!","readmeFilename":"README.md"}