Test

README.md

@@ -1,14 +1,23 @@
 # nvr-notify-api
 
-A Go-based API server that receives and processes HTTP event notifications from Vivotek Network Video Recorders (NVRs).
+
+A Go-based API server that receives and processes HTTP event notifications from Network Video Recorders (NVRs) and IP cameras.
 
 ## Features
 
-- Receives event notifications from Vivotek NVR devices
+- Supports multiple NVR brands:
-- Processes different event types (motion detection, video loss, device connection)
+  - Vivotek NVR JSON events
-- Configurable logging
+  - HIKVision alarm server XML notifications
+- Processes common event types:
+  - Motion detection
+  - Video loss
+  - Device connection/disconnection
+  - Line crossing (HIKVision)
+  - Intrusion detection (HIKVision)
+  - IO alarms (HIKVision)
+- Configurable logging system
 - Optional HTTP Basic Authentication
-- Event forwarding to external notification services
+- Event forwarding to external services
 - Telegram integration for instant notifications
 - Health check endpoint
 - Docker support
@@ -20,13 +29,16 @@ The application can be configured using the `config.json` file:
 ```json
 {
   "server_port": "8080",
-  "log_file": "vivotek_events.log",
+  "log_file": "nvr_events.log",
   "notify_url": "https://your-notification-service.com/webhook",
   "auth_username": "admin",
   "auth_password": "your-secure-password",
   "telegram_enabled": true,
   "telegram_token": "YOUR_TELEGRAM_BOT_TOKEN",
-  "telegram_chat_id": "YOUR_CHAT_ID"
+  "telegram_chat_id": "YOUR_CHAT_ID",
+  "hik_enabled": true,
+  "hik_username": "hikvision",
+  "hik_password": "hikvision-password"
 }
 ```
 
@@ -34,19 +46,23 @@ Configuration options:
 - `server_port`: Port the HTTP server will listen on
 - `log_file`: Path to log file (use "stdout" to log to console)
 - `notify_url`: Optional URL to forward events to
-- `auth_username` and `auth_password`: Optional Basic Authentication credentials
+- `auth_username` and `auth_password`: Basic Authentication credentials
 - `telegram_enabled`: Set to true to enable Telegram notifications
 - `telegram_token`: Your Telegram bot token (obtained from @BotFather)
 - `telegram_chat_id`: Your Telegram chat ID where notifications should be sent
+- `hik_enabled`: Set to true to enable HIKVision-specific authentication
+- `hik_username` and `hik_password`: Optional HIKVision-specific auth credentials
 
 ## API Endpoints
 
-- `/event` or `/events`: POST endpoint for receiving event notifications
+- `/event` or `/events`: POST endpoint for receiving Vivotek NVR event notifications
+- `/hikvision/alarm`: POST endpoint for receiving HIKVision alarm server notifications
 - `/health`: GET endpoint to check service status
 
 ## Event Format
 
-The API expects events in JSON format:
+### Vivotek Events
+The API expects Vivotek events in JSON format:
 
 ```json
 {
@@ -61,60 +77,13 @@ The API expects events in JSON format:
 }
 ```
 
-## Running the Application
+### HIKVision Events
+HIKVision events are expected in XML format according to the HIKVision alarm server protocol:
 
-### Directly
+```xml
-
+<EventNotificationAlert>
-```bash
+  <ipAddress>192.168.1.64</ipAddress>
-go mod tidy
+  <portNo>80</portNo>
-go build
+  <protocolType>HTTP</protocolType>
-./vivotek-nvr-api
+  <macAddress>00:11:22:33:44:55</macAddress>
-```
+  <channelID>1</channelID>
-
-### Using Docker
-
-```bash
-# Build the Docker image
-docker build -t vivotek-nvr-api .
-
-# Run the container
-docker run -p 8080:8080 -v ./config.json:/app/config.json -v ./logs:/app/logs vivotek-nvr-api
-```
-
-## Configuring Vivotek NVR
-
-To configure your Vivotek NVR to send events to this API:
-
-1. Access your NVR's web interface
-2. Navigate to Configuration > Event > HTTP Notification
-3. Enable HTTP notifications
-4. Set the URL to `http://your-server-ip:8080/event`
-5. Set the authentication method if you've configured it in the API
-6. Select the events you want to be notified about
-7. Save the configuration
-
-## Extending the API
-
-To handle additional event types, modify the `processEvent` function in the main Go file and add appropriate handler functions.
-
-## Setting Up Telegram Notifications
-
-1. Create a Telegram bot:
-   - Start a chat with [@BotFather](https://t.me/botfather) on Telegram
-   - Send the command `/newbot` and follow the instructions
-   - Once created, BotFather will provide a token - copy this to your config file
-
-2. Get your chat ID:
-   - Option 1: Start a chat with your bot and send a message to it
-   - Option 2: Send a message to [@userinfobot](https://t.me/userinfobot) to get your chat ID
-   - Option 3: For group chats, add [@RawDataBot](https://t.me/RawDataBot) to your group briefly
-
-3. Update your config file:
-   - Set `telegram_enabled` to `true`
-   - Add your bot token to `telegram_token`
-   - Add your chat ID to `telegram_chat_id`
-
-4. Test the configuration:
-   - Start the API server
-   - Trigger an event from your Vivotek NVR
-   - You should receive a formatted message in your Telegram chat