@@ -1,9 +1,13 @@
 *.pyc
+*.pyo
+__pycache__/
 *.log
 play.wav
 server.json
 .tox
 AlarmPI.egg-info
 settings*.json
 !*_template.json
-venv
+venv/
+.venv/
+.pytest_cache/
@@ -1,76 +1,93 @@
 # AlarmPI ![Build Status](https://github.com/bkbilly/AlarmPI/workflows/build/badge.svg) [![GitHub release (latest by date)](https://img.shields.io/github/v/release/bkbilly/AlarmPI)](https://github.com/bkbilly/AlarmPI/releases/latest)
 
-AlarmPI is a home security system based on Raspberry PI. It supports wired sensors (PIR, Magnetic etc.) and wireless through MQTT or Hikvision. It is controlled with a Web UI, a Android Application, or through HTTP & MQTT messages. When the alarm detects movement, it supports the following events:
- * Enables the Siren
- * Send Mail
- * VoIP Calls
- * Send MQTT message
+**AlarmPI** is a modern, modular home security and automation system designed for Raspberry Pi and Linux systems. It features a fully dynamic, plugin-based architecture for both **Sensors** and **Notifiers**, backed by a sleek real-time Web dashboard and Home Assistant integration.
 
-It is written in python and supports both python 2.7 & python 3.6. There is also the option of having more than one user by editing the server.json file accordingly.
+---
 
+## Key Features
 
-## Installation
-With this command on your terminal you can install and update the application with my latest commit.
-```bash
-bash <(curl -s "https://raw.githubusercontent.com/bkbilly/AlarmPI/master/install.sh")
+- **Folder-Based Modular Plugins**:
+  - **Notifiers** (`alarmcode/notifiers/`): Drop in any `.py` file to automatically register new notification channels (e.g., Telegram, Pushover, Discord, Webhooks) without editing core code.
+  - **Sensors** (`alarmcode/sensors/`): Easily add custom sensor drivers (GPIO, Hikvision cameras, MQTT, Virtual/Webhooks).
+- **Smart Arming & Sensor Behaviors**:
+  - **Arm After Closing**: Instantly arms the system as soon as entry/exit doors close without waiting for remaining exit delay.
+  - **Auto-Bypass Open Sensors (Force Arm)**: Automatically bypasses open windows/doors upon arming without blocking system arming.
+  - **Entry & Exit Delays**: Configurable grace periods with live countdown and audio warning beeps.
+  - **Door Chime**: Plays gentle browser & system chimes when perimeter doors open while disarmed.
+  - **Rich Sensor Behaviors**: `Normal (Armed only)`, `Entry/Exit (Delay Countdown)`, `Instant Breach`, `24-Hours (Always Active: Smoke/Tamper)`, and `Chime`.
+  - **Siren Auto-Cutoff**: Configurable siren timeout to prevent battery drain and comply with noise ordinances.
+- **Dynamic Backend Settings**: All plugin schemas and configuration parameters are defined on the backend and dynamically rendered on the frontend UI.
+- **Modern Hardware & OS Compatibility**: Compatible with Python 3.10 – 3.14+, Raspberry Pi OS (Debian Bookworm / Pi 5), with transparent hardware/virtual GPIO fallback for development and testing.
+- **Real-Time Web Dashboard**: Responsive dark-mode interface with live Socket.IO state synchronization, interactive zone arming/disarming, and visual sensor timelines.
+- **Home Assistant & MQTT Discovery**: Instant integration with Home Assistant via MQTT Discovery (Alarm Control Panel, Siren, Binary Sensors).
+
+---
+
+## Modular Plugin Architecture
+
+### Adding a Notification Plugin
+Create a new file in [`alarmcode/notifiers/`](file:///home/bkbilly/Documents/AlarmPI/alarmcode/notifiers/) (e.g. `telegram.py`):
+
+```python
+from alarmcode.notifiers.base import BaseNotifier, NotifierField
+
+class TelegramNotifier(BaseNotifier):
+    name = "telegram"
+    display_name = "Telegram Bot"
+    description = "Send instant alert messages and photos via Telegram Bot API."
+    icon = "send"
+
+    @classmethod
+    def define_fields(cls):
+        return [
+            NotifierField("enable", "Enable Telegram", "boolean", default=False),
+            NotifierField("bot_token", "Bot Token", "password", default=""),
+            NotifierField("chat_ids", "Chat IDs", "list", default=[], placeholder="1234567, 9876543"),
+        ]
+
+    def on_intruder_alert(self, alert_info=None):
+        if self.is_enabled():
+            # Send alert to Telegram...
+            pass
 ```
+*AlarmPI will automatically discover your plugin, add its configuration schema to the backend, and render its controls and live status badge in the Settings UI!*
+
+---
+
+### Adding a Sensor Plugin
+Create a new file in [`alarmcode/sensors/`](file:///home/bkbilly/Documents/AlarmPI/alarmcode/sensors/) (e.g. `zigbee.py`):
+
+```python
+from alarmcode.sensors.base import BaseSensorPlugin, SensorField
+
+class ZigbeeSensorPlugin(BaseSensorPlugin):
+    sensor_type = "Zigbee"
+    display_name = "Zigbee Device"
+    description = "Monitor Zigbee door sensors and PIR detectors."
+
+    @classmethod
+    def define_fields(cls):
+        return [
+            SensorField("device_ieee", "Device IEEE Address", "string", required=True),
+        ]
+```
+
+---
+
+## Installation & Running
+
+```bash
+# Clone the repository
+git clone https://github.com/bkbilly/AlarmPI.git
+cd AlarmPI
+
+# Create virtual environment and install dependencies
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
 
-## Usage
-### Web UI
-The Web Interface of the alarm has all the features that are needed to configure and use the home security. It supports real time events of the sensors, the logs and their status.
-It also works as an smartphone application from the browser: _Add to Home screen_
-
-### Mobile Application
-The android application is very light and fast and it is recomended for the phone, but it has no real time updates.
-You can download it from here: [Play Store](https://play.google.com/store/apps/details?id=bkbilly.alarmpi)
-
-The source code for the application is here: https://github.com/bkbilly/AlarmPI-Android
-
-### Snips
-Through voice commands from Snips platform using this application: [snips console](https://console.snips.ai/store/en/skill_G4V82q5rb2)
-
-### Home-Assistant
-It is also controlled with MQTT commands with the Home-Assistant component: 'MQTT Alarm Control Panel'.
-On Home-Assistant the configuration is like so:
-```yaml
-alarm_control_panel:
-  - platform: mqtt
-    name: "AlarmPI"
-    state_topic: "home/alarm"        # The State Topic from AlarmPI
-    command_topic: "home/alarm/set"  # The Command Topic from AlarmPI
-    payload_arm_home: "ARM_HOME"     # This is not used
-    payload_arm_away: "ARM_AWAY"
+# Start the server
+python3 run.py
 ```
 
-## API
-### HTTP
-  * `https://admin:secret@example.com:5000/setSensorStatus?name=test1&state=off`
-  * `https://admin:secret@example.com:5000/activateAlarmZone?zones=home,away`
-  * `https://admin:secret@example.com:5000/activateAlarmOnline`
-  * `https://admin:secret@example.com:5000/deactivateAlarmOnline`
-  * `https://admin:secret@example.com:5000/stopSiren`
-  * `https://admin:secret@example.com:5000/startSiren`
-  * `https://example.com:5000/login?username=admin&password=secret`
-
-### MQTT
-These are the possible mqtt messages. First you will have to setup the MQTT state_topc & command_topic.
-  * `home/alarm/set` [ARM_HOME,ARM_AWAY,ARM_NIGHT,DISARM,PENDING]
-  * `home/alarm/set/siren` {"state": "ON"}
-  * `home/alarm/set/sensor/test1` [off,online]
-  * `home/alarm/sensor/test1` [off,on,error]
-  * `home/alarm` [armed_away,disarmed,triggered]
-
-Supports custom messages subscriptions on MQTT Sensors by filling the appropriate information about topic and payload on sensor settings. This can be used for cases like zigbee2mqtt so that zigbee devices can be used. The payload must be a python function with the payload stored as `message` like this:
- * message['contact'] == 'ON'
-
-### IFTTT
-It can also be used with IFTTT using the Webhooks module like this:
-`https://admin:secret@example.com:5000/activateAlarmOnline`
-`https://admin:secret@example.com:5000/deactivateAlarmOnline`
->My personal favourite is to control it with Google Assistant.
-
-## SipCall (VoIP)
-I have built the sipcall for the Raspberry Pi, so hopefully you will not have to build it yourself.
-To test it, execute this replacing the (myserver, myusername, mypassword, mynumbertocall):
-
-`./sipcall -sd myserver -su myusername -sp mypassword -pn mynumbertocall -s 1 -mr 2 -ttsf ../play.wav`
+Open your browser at `http://localhost:5000` (Default credentials: `test1` / `secret`).