Devices with firmware v1.0 or later (units sold from December 2021 onwards) need to be registered and configured for the first time. If your device is not yet registered, follow this article on how to do so: Registering your device and getting started.
For configuring your device, first you need to make it work on AP (access point) mode and connect to enter the configuration screen.
- Reset your device (pressing the reset button). The green led will start to blink fast for 30 second
- Connect with a smartphone, a laptot or any other WiFi capable device to the network with the name you specified as “Thing name” or “Device Name” on the first configuration, and use the last password you configured at the same time. You will be redirected to the welcome screen where the device ID is displayed.
Tap Config to enter to the configuration screen. Then, you will see a list of parameters to be configured grouped in sections. Parameters are available depending on firmware versions, therefore some parameters may not be available in all devices.
This section contains the minimal configuration your device needs to connect to a WiFi Network and also the SSID and password needed to connect when working on AP mode. At this point this parameter are already configured in your device and are not shown for security reasons. Complete the fields only if you need to update the information. For instance, because the the network your have been using so far to connect has now a new password or need to be replaced because is not longer available.
Device name or Thing name: This is the name of your device and the SSID that it will display when acting as an Access Point to allow connections, to be configured.
AP password: This is the password to connect to the device when acting as an Access Point to allow connections, to be configured. It is mandatoy to be changed for the settings to be saved. What if I forget it?
WiFi SSID: This is the name of the network you want the device connects to provide its funtionality. During the registration process internet access is requied. Afterwards, internet access could be reuquired or not, depending on your use case.
Wifi Password: This is the password of the network you want the device connects to provide its funtionality, specified in the previous field.
This section contains the information the device need to send for its registration and for geting its device ID. If you haven’t registrered your device yet, follow this article to do so: Registering your device and getting started.
Home Assistant MQTT Discovery
This section is for setting whether the Home Assistant MQTT Discovery integration will be used.
- Enable Home Assistant MQTT Discovery: Set this parameter to Yes to make the device publish its configuration on the MQTT broker.
- Default MQTT Discovery Prefix: This is the prefix for the topics used with the service. Since this is the default option in Home Assistant, do not change this parameter unless your Home Assistant instalation is confifured differently.
This section contains the access code required to disarm the alarm system and may be also required to arm based on panel configuration.
This parameter is mandatory when integrating with non keyboarded interfaces like Home Assistant, but if you will use it with a virtual keyboard (for instance) it is optional.
It´s a good practice to configure a user code on the alarm system to be used exclusively with the device as Access Code in order to be able to identify the usage on the alarm system log.
MQTT connection settings are specified on this section
- MQTT server URL: MQTT server address. It could be an URL or an IP v4 adddress.
- MQTT Server Port: Port to connect to the MQTT broker. Usually 1883 for unsecured conections and 8883 secured connections.
- Is Secure Port?: Whether connection is secured or not. (TLS v1.2)
- MQTT Username: Username for connecting to MQTT broker
- MQTT Password: Password for connecting to MQTT broker
- MQTT Client ID: MQTT connection client ID
- MQTT Retain: Whether MQTT messages will be published with retain flag or not. 1 or Yes for enabled, 0 or No for disabled.
- MQTT QoS: QoS value to publish MQTT messages.
In the MQTT Advance configuration group, MQTT topics, topic prefixes and other parameters can be configured.
- Status Topic: MQTT topic where the device will publish the Birth Message when connected to the broker, and where the broker will publish upon disconnection. Also a status message will be published in this topic if connection with the alarm system is lost.
- Birth Message: The payload of the message to be published on the Status Topic when connection to the broker is stablished.
- LWT Message: Last Will Testament Message is the payload of the message the broker will publish on the Status Topic upon device disconnection.
- Disconnected Message: The payload of the message that will be published in the Status Topic if connection between the device and the alarm system is lost.
- Partition Topic Prefix: The device will append the partition number to this prefix to build the topic where the partition state will be published. For instance, if this parameter is set to Partition, the state of partition 1 will be published on topic deviceID/Partition1, the state of partition 2 will be published on deviceID/Partition2 and so on and so forth. Payloads for partition states are: disarmed, armed_away, armed_home, triggered and pending.
- Active Partition Topic: The device will publish the active partition on this topic. Meaning that every time user change to a partition to send a command, this data will change.
- Zone Partition Prefix: The device will append the zone number to this prefix to build the topic where the zone state will be published. For instance, if this parameter is set to Zone, the state of zone 1 will be published on topic deviceID/Zone1, the state of zone 2 will be published on deviceID/Zone2 and so on and so forth. Payloads for zone states are: 1 for active and o for idle.
- Fire Topic Prefix: The device will append the partition number to this prefix to build the topic where the fire stat of the partition will be published. For instance, if this parameter is set to Fire, the fire state of partition 1 will be published on topic deviceID/Fire1, the fire state of partition 2 will be published on deviceID/Fire2 and so on and so forth. Payloads for partition fire states are: 1 for active and o for idle.
- Trouble Topic: The device will publish the trouble status in this topic.
- Commands Topic: This is the topic the device will subscribe to receive the commands and messages that will be issued to the alarm system. Keys pressed on a virtual keypad will be also published on this topic.
- Keep Alive Topic: This is the topic where the keep alive messages will be published. The message payload depends on firmware version but usually includes the state of the connection with the Alarm system, with MQTT brokers and the WiFi signal strength.
- Keep Alive interval (seconds): If this parameter is greater than 0, the device will publish a keep alive message every time this interval is elapsed.
Remote Update Firmware
This section is for Over The Air (OTA) firmware update.
For updating your device firmware, please refer to this article: Updating BRDSC01 firmware
Once all parameters are configured according to your needs, tap on Apply at the bottom of the configuration screen to save the settings and reboot the device.