Zum Hauptinhalt springen

Bosch Alarm Smart-Home-Integration, kostenlos und Open Source

Bosch Alarm-Integration für Gladys Assistant

Bosch Solution, AMAX, B and G Series alarm panels, locally (Mode 2).

Auf GitHub ansehenAlle Integrationen
Info

Die Dokumentation dieser Integration wird von ihrem Autor geschrieben und ist bisher nur auf Englisch verfügbar.

This integration links a Bosch alarm panel to Gladys Assistant, locally over your network, with Bosch's "Mode 2" automation protocol: Solution 2000, 3000, 4000 (and 2100, 3100, 4100), AMAX 2100, 3000, 4000, B Series (B3512, B4512, B5512, B6512), G Series (B8512G, B9512G) and D7412GV4 / D9412GV4.

Never tested with a real device. The protocol comes from the bosch-alarm-mode2 0.4.11 library (the one of the Home Assistant Bosch Alarm integration), ported to JavaScript and checked against a simulated panel only. Make your first tries on site, with the panel disarmed, and report what goes wrong.

Unofficial integration, not affiliated with Bosch.

Before you start​

  • The panel on your network (built-in network module, or the B426 / B450 / IP module of the panel), reachable from Gladys: give it a fixed address in your router.
  • Automation (Mode 2) enabled on the panel by your installer (A-Link Plus, RPS or Installer Services), with its port (7700 by default) and:
    • B, G Series and GV4: an automation code;
    • AMAX: an automation code and the installer code;
    • Solution: the code of a user (no automation code).
  • The panel takes a limited number of automation connections: if another software holds them all (Home Assistant, another Gladys…), the integration says so and tries again one minute later at the earliest.

What you get​

The areas, points and outputs are the ones the panel declares, with their names.

  • Bosch panel: connected or not, trouble, AC power failure, battery low or missing (model, firmware and serial number as parameters).
  • One device per area:
    • State, read-only: disarmed, arming (exit delay), entry delay, armed (away), armed (stay);
    • Armed, Ready to arm (panels with a subscription), Alarm in progress (an armed area with a burglary, gas or fire alarm in memory), Fire alarm memory (until it is cleared at a keypad);
    • three buttons: arm away, arm stay, disarm.
  • One device per point: open or closed (opening, motion, smoke or leak, as chosen).
  • One device per output: on or off, and two buttons: turn on, turn off.
  • Scene triggers: alarm triggered (with the point when the panel gives it, and whether it is a fire), area armed (mode, asked by Gladys or not), area disarmed.
  • Scene actions: arm (away or stay), disarm.

No command is a switch: a "turn everything off" of a voice assistant, of HomeKit or of a scene can neither disarm the alarm nor drive an output. The states are read-only, the commands are buttons.

Configuration​

  1. Address of the panel: the IP address of its network module.
  2. Automation port: 7700, unless your installer changed it.
  3. Automation code: B, G Series, GV4 and AMAX (not used by Solution).
  4. User code (Solution) or installer code (AMAX): 8 digits at most. Not used by B and G Series. For Solution, create a dedicated user with only the rights Gladys needs.
  5. Kind of the points (optional): e.g. 7:motion, 9-10:smoke, 12:leak. Kinds: opening (default), motion, smoke, leak. Changing the kind of a point already created in Gladys adds a new feature and keeps the old one (and its history): delete the old one by hand if you do not want it.
  6. Safety: see below.
  7. Language of the names: French or English.

The codes are secret fields: kept by Gladys in its database, never shown again in the interface, sent only to the panel. They never appear in the logs nor in /data.

The Test the connection button connects at once when no connection is open (else it waits for the one in progress) and tells the model, the state of the areas and the number of points and outputs. It never jumps ahead of a new try already planned (a wait after a cut or "no free connection"): it then tells the current state.

The Allow a new try of the code button lifts the stop set after a refused code (see "Safety"): the integration logs in once more with the codes of the configuration.

What travels on the network​

  • The link with the panel goes through TLS, without a check of the panel's certificate (as Home Assistant does: the panel has a self-signed certificate). A device that only listens to your network cannot read the exchanges; a device able to pose as the panel on your local network could receive the codes.
  • The codes are sent at each login to the panel.
  • Protect your network (a separate guest Wi-Fi for the devices you are not sure of) and give Gladys a code with limited rights.

Safety​

  • Arming is always allowed, without an option: it is a protective command. Arming while someone is inside (a badly set scene, a mistake) may raise a false alarm, the sirens and a call of your alarm monitoring company.
  • Disarming is off by default. Once the option is checked, every Gladys user, every scene and the Gladys mobile app can disarm without typing any code. Allow it only if your Gladys is well protected (accounts, remote access). Going from armed away to armed stay lowers the protection: it needs this option too.
  • The outputs are off by default, behind their own option: an output may drive a siren, a gate or a lock. Check what each one does first.
  • The options are read again right before each send: an option unchecked while a command waits its turn blocks that command.
  • Before each command, the integration reads the state from the panel again and decides on that state, never on what it has in memory (already in the asked state: nothing is sent; entry delay running: arming refused). The commands go one at a time, in order. A command whose time ran out while it waited its turn is refused, nothing is sent. An arming goes before the disarms and outputs waiting, and withdraws a disarm of the same area, waiting or in progress, as long as it has not left for the panel.
  • A command that cannot leave in time (slow panel, unreadable state) is refused with "nothing was sent". A command that left without a clear answer (no answer, a cut) is reported "sent, without confirmation": the connection is restarted at once (about 5 s) and the state read again as soon as it is back; it is never reported "not sent". Only a refusal of the panel is reported "refused" (no right, cannot arm…).
  • If the panel refuses a code at login, the integration stops and never sends it again by itself, even after a restart (a panel may count wrong codes and report a code tamper). The same goes when the panel does not answer the login clearly twice in a row (connection closed, no answer within 15 s, unreadable answer): the code may have been refused. Change a code in the configuration, or click "Allow a new try of the code" (one try per click). The file /data/bosch-alarm-state.json only keeps the date of the stop, never a code; the stop holds even if the address of the panel changes. An unreadable file counts as a stop (and is told as such); if the stop cannot be written, the connection status says so.
  • Every command, sent or refused, is written in the integration logs; the codes never are.

Connection​

  • One connection at a time, never two: at least 5 seconds between two connections.
  • After a cut, the new tries are spaced: 10 s, 30 s, 1 min, 2 min, then every 5 minutes; at least one minute when the panel has no free connection, five minutes for an unknown model. A connection that drops less than a minute after it opened counts as a failure (the waits grow). After a command without an answer, the connection is back in about 5 s.
  • The panels that can send each change themselves do (subscription); the others are read every 2 seconds. Everything is read again every 10 minutes, the faults every minute.
  • A request after 60 seconds of silence checks that the panel still answers; with nothing received for 150 s, or no answer to a request, the integration reconnects.

Known limits​

  • Never tested with a real device (see above).
  • No event log, no doors (access control of the B and G Series), no instant arming, no clock setting in this version.
  • "Ready to arm" only exists on the panels that send their changes (subscription).
  • Outputs over 255 are shown but cannot be controlled (the protocol command takes one byte).
  • An alarm already in progress when the integration starts does not trigger a scene (only the changes seen do).
  • The alarm memory stays on the panel until it is cleared at a keypad: arming again an area whose memory was not cleared triggers "Bosch alarm triggered" again (as in Home Assistant). Clear the memory at a keypad after an alarm.
  • Frames over 8 KB are refused (the connection is restarted).

Privacy​

Everything stays on your network: the integration talks to the panel only.

Licence​

Apache-2.0. Protocol logic ported from bosch-alarm-mode2 0.4.11 (MIT, Michael Grigoriev): see THIRD_PARTY_NOTICES.md.

Konfigurationseinstellungen​

Diese Einstellungen fragt Bosch Alarm in seinem Konfigurationsbildschirm in Gladys ab.

EinstellungTypPflichtfeldBeschreibung
Your Bosch alarm panelsectionNeinFor Bosch Solution 2000/3000/4000, AMAX 2100/3000/4000, B Series (B3512 to B6512), G Series (B8512G, B9512G) and GV4 panels with their network module, on your network, without any cloud, through the "Mode 2" automation protocol: the state of each area (disarmed, arming, armed away or stay, entry delay, alarm, fire alarm memory), its points (open or closed), the outputs, the panel troubles, arm and disarm buttons, scene triggers. Enable the automation (Mode 2) on the panel with Bosch's installer software (A-Link Plus, RPS). Never tested on a real panel. Unofficial, not affiliated with Bosch.
Address of the panelstringJaThe IP address of its network module (give it a fixed address in your router).
Automation portnumberNein7700 unless your installer changed it.
Automation codesecretNeinB, G Series, GV4 and AMAX panels: the automation passcode set by your installer (not used by Solution panels). It is sent to the panel at each login, over TLS without a check of the panel's certificate. A code refused by the panel is never sent again by itself ("Allow a new try of the code" button). Kept by Gladys in its database, never shown again, sent only to the panel, never in the logs.
User code (Solution) or installer code (AMAX)secretNeinSolution panels: the code of a user (up to 8 digits) with the rights Gladys needs. AMAX panels: the installer code (up to 8 digits), with the automation code above. Not used by B and G Series. It is sent to the panel at each login, over TLS without a check of the panel's certificate. A code refused by the panel is never sent again by itself ("Allow a new try of the code" button). Kept by Gladys in its database, never shown again, sent only to the panel, never in the logs.
Kind of the pointsstringNeinOptional: points that are not openings, e.g. "7:motion, 9-10:smoke, 12:leak" (opening, motion, smoke, leak). Every other point shows as an opening.
SafetysectionNeinAnyone who can control the devices in Gladys (dashboard, scenes, the Gladys app) can use the alarm through this integration. Arming is always allowed: arming while someone is inside (a scene, a mistake) may raise a false alarm, sirens and a call of your alarm monitoring company. Disarming and the outputs (which may drive a siren, a gate or a lock) are off by default, each behind its own option: allow them only if your Gladys is well protected. Every command is written in the integration logs; the codes never are.
Allow disarming from GladysbooleanNeinOnce checked, every Gladys user, every scene and the Gladys mobile app can disarm, without typing any code. Also needed to go from armed away to armed stay (a lower protection).
Allow controlling the outputs from GladysbooleanNeinTurn on / turn off buttons of the outputs. An output may drive a siren, a gate or a lock: check what each one does first.
Language of the namesselectNeinUsed for the names of the devices and features added from now on, and for the area state.

So installierst du Bosch Alarm in Gladys​

  1. Öffne in Gladys Integrationen: Bosch Alarm erscheint im Katalog neben den nativen Integrationen, mit einem Community-Badge.
  2. Klicke auf Installieren. Gladys lädt das Docker-Image (ghcr.io/lm1lc3n7/gladys-bosch-alarm:0.1.1) herunter, startet es in einer vom Kern isolierten Sandbox und erzeugt die Oberfläche der Integration (Geräte, Erkennung und Konfiguration).
  3. Öffne den Bildschirm Konfiguration der Integration, fülle die Einstellungen aus und speichere.
  4. Du kannst sie auch direkt über die URL ihres Repositorys installieren: https://github.com/LM1LC3N7/gladys-bosch-alarm.

Bosch Alarm benötigt Gladys >=5.1.0. Der Katalog in Gladys wird stündlich aktualisiert, eine neue Version ist also spätestens eine Stunde nach ihrer Veröffentlichung verfügbar.

Du nutzt Gladys noch nicht? Es ist kostenlos und Open Source: folge der Installationsanleitung, um loszulegen.

Über externe Integrationen​

Bosch Alarm ist eine externe Integration: eine Community-Integration, die als Docker-Container verpackt und auf GitHub veröffentlicht wird. Gladys installiert sie mit einem Klick und führt sie in einer vom Kern isolierten Sandbox aus. Sie wird von LM1LC3N7 veröffentlicht und gepflegt, nicht vom Gladys-Kernteam.

Abonniere den Newsletter von Gladys Assistant

Ein paar E-Mails im Monat zu neuen Releases und Neuigkeiten aus dem Projekt. Verschickt von Pierre-Gilles Leymarie, dem Gründer des Projekts. Jederzeit abbestellbar 🙂
Zuletzt aktualisiert am