Configuration

Configuration Sample

{
  "name": "Flume",
  "username": "[email protected]",
  "password": "password",
  "clientId": "1234567890ABCD",
  "clientSecret": "1234567890ABCDEFGHIJ",
  "refreshInterval": 1,
  "threshold": 0.1,
  "disableDeviceLogging": false,
  "debug": false,
  "disablePlugin": false,
  "platform": "Flume"
}

Required Fields

• username - Your Flume username
• password - Your Flume password
• clientId - Your Flume Client ID, found at https://portal.flumetech.com.
• clientSecret - Your Flume Client Secret, found at https://portal.flumetech.com.

Optional Fields

• refreshInterval - Number of minutes between updates. Must be 1 or more.
• threshold - Ignore a steady water draw below this value in gallons per refresh interval. Must be 0 or more.
• disableDeviceLogging - Global logging setting for accessory status changes. If true then accessory status changes will not be logged.
• debug - Global logging setting for the plugin. If true then debug information will be added to the log.
• disablePlugin - If true, the plugin will remove all accessories and not load the plugin on restart.

Retrieving Client ID & Secret

• You'll need to get your API Access Client ID and Client Secret from the Flume website at https://portal.flumetech.com.
• This guide offers the steps to take - https://flumetech.readme.io/reference#accessing-the-api.