Skip to content

Configuration

Fredrick Bäcker edited this page Jan 11, 2020 · 6 revisions

It's possible to override the default values to customize.

Create an empty json file called ./config/local.json or copy ./config/default.json.

IMPORTANT: Make sure not to change the default.json file, this will break updates.

Change properties

All settings in local.json will override the default.json settings.

{

  // Log output.
  "logging": {
    // Log level: get more info with: "debug"
    "level": "info",
    // Set to disable to not send crash logs to remote service
    "remote": true
  },

  // MQTT Connection settings.
  // Possible to use MQTT client properties
  // https://www.npmjs.com/package/mqtt#client

  "mqtt": {
    "host": "127.0.0.1",
    "port": 1883,
    "protocol": "mqtt",
    // start string for all pub/sub.
    "subscribeBasePath": "broadlink/"
  },

  "queue": {
    // Delay between commands sent to broadlink
    "delay": 500
  },

  "webhooks": {
    // GET url request to an url when finding devices are done.
    // e.g. Call node-red api to trigger action when broadlink bridge is ready for commands
    "scanCompleted": null
  },

  // Recording settings
  "recording": {
    "timeout": {
      "ir": 15,
      "rf": 15
    },
    // Custom path for saved commands. If not specified the ${dir}/commands will be used.
    "path": null
  },

  // port numbers for gui and logs
  "gui": {
    "port": 3000,
    "logs": 3001 // NOTE: This is not dynamic yet
  }
}
Clone this wiki locally