Skip to content

Configuration

Luke Stephens edited this page Nov 24, 2024 · 2 revisions

To configure the Homebridge WS Olarm Plugin, you need to update your Homebridge config.json file.

Configuration Fields

  • platform: (Required) Must be set to "OlarmWSHomebridgePlugin".
  • name: (Required) A name for your Olarm platform.
  • userEmailPhone: (Required) Your Olarm account email or phone number.
  • userPass: (Required) Your Olarm account password.

Example Configuration

{
  "platforms": [
    {
      "platform": "OlarmWSHomebridgePlugin",
      "name": "My Olarm",
      "userEmailPhone": "[email protected]",
      "userPass": "your-password"
    }
  ]
}

Steps

Open the config.json file:

  1. The file is usually located at ~/.homebridge/config.json.

  2. Add the Olarm platform configuration: Insert the configuration block within the "platforms" array as shown in the example above.

  3. Save the file and restart Homebridge:

    sudo systemctl restart homebridge

Additional Notes

  • Ensure your credentials are correct to avoid authentication issues.
  • For advanced configuration options, refer to the Development page.
Clone this wiki locally