config.sample.json5

{
  "blink1": {
    // optional, use specific blink(1) device identified via serial. If parameter is not set, the first blink(1) device will be used
    "serial": "string",
    // experimental,  if enabled this setting allows hot plugging the blink(1) device. Setting this to true will not abort the script when no device is found.
    //                This setting allows to unplug/replug the blink(1) device while the script is running
    //                This parameter is experimental and not production ready yet.
    "hotplug": false
  },
  "api": {
    // required, absolute URI where your pfsense is running
    "baseUrl": "https://xxx.local",
    // required, Client id which can be created using the instructions in jaredhendrickson13/pfsense-api
    "client": "clientid",
    // required, API token which can be created using the instructions in jaredhendrickson13/pfsense-api
    "token": "secret",
    // optional, Status check interval in milliseconds (recommended setting >1000)
    "interval": 5000,
    // optional, timeout in milliseconds when an API request should be marked as failed
    "timeout": 5000,
    "httpsAgent": {
      // optional, allow/disallow self signed ssl certificates (should be set to true for security reasons)
      "rejectUnauthorized": true
    }
  },
  "indicator": {
    // optional, configure temperature thresholds (in Celsius) and a indication color (rgb value) (see /types/TemperatureThreshold)
    "temperatureThresholds": [
      { threshold: 0, color: { red: 36, green: 189, blue: 46 } },  // green
      { threshold: 60, color: { red: 246, green: 225, blue: 36 } }, // yellow
      { threshold: 70, color: { red: 188, green: 19, blue: 18 } },  // red
    ],
    // optional, indicator when an api request is beeing performed
    "apiRequest": {
      // optional, choose which LED should flash (blink(1) mk2+ only), valid values are Blink1LedPosition{Top|Bottom|All|None}
      "ledPosition": "Bottom"
    }
  },
  "log": {
    // optional, set minimum log level, valid values are {silly|verbose|info|http|warn|error|silent} (see npmlog)
    "level": "info"
  }
}