t0mer / redalert Goto Github PK

View Code? Open in Web Editor NEW

10.0 2.0 8.0 96 KB

Ubuntu based image running python script that reads json from Oref Website. and publishes it over MQTT Protocol.

License: Apache License 2.0

Dockerfile 20.20% Python 79.80%

docker home-assistant homeassistant mqtt python

redalert's Introduction

Red Alert Docker

Ubuntu based image running python script that reads json from Oref Website.
and publishes it over MQTT Protocol.

Base Image

From ubuntu:18.04 described here.

18/05/2021 Major update

Thanks to the amazing work of @caronc on the apprise you can now send notification using variety of notification channels, like:

Telegram - tgram://bottoken/ChatID
Home-Assistant - hassio://user@hostname/accesstoken
IFTTT - ifttt://{WebhookID}@{Event}/
Slack - slack://TokenA/TokenB/TokenC/Channel
Microsoft Teams - msteams://TokenA/TokenB/TokenC/

And much musch more. you can find it all on the project Wiki.

This update also contains:

Reducing the length of the data sends over the Mqtt prorocol, it is now contains regions only.
Added detaild log.
Fixed the bug that causing sendind multiple alerts.

Image configuration

Enviroment variables

MQTT_HOST
used for setting the MQTT Broker address, default value is 127.0.0.1.
MQTT_PORT
used for setting the MQTT Broker Port, default value is 1883.
MQTT_USER
used for setting the MQTT Broker Username, default value is user.
MQTT_PASS
used for setting the MQTT Broker Password, default value is password.
DEBUG_MODE
used for setting the script to run in test mode wich will read json from test url.
INCLUDE_TEST_ALERTS
used to show pikud ha oref tests, default is False.
REGION
used for setting the region for monitoring. default is * (any)
NOTIFIERS
use apprise notification. you can use multiple notifiers separated by space python for example:
tgram://bottoken/ChatID hassio://user@hostname/accesstoken slack://TokenA/TokenB/TokenC/Channel
MQTT_TOPIC
Custom MQTT Topic. default value is /redalert

Usage

Run from hub

docker run from hub

docker run  -e MQTT_HOST="broker ip / fqdn" -e MQTT_PORT="1883" -e MQTT_USER="username" -e MQTT_PASS="password" -e DEBUG_MODE="False" -e REGION="*" --name redalert techblog/redalert:latest

docker-compose from hub

version: "3.6"
services:
  redalert:
    image: techblog/redalert
    container_name: redalert
    restart: always
    environment:
      - MQTT_HOST=[Broker Address]
      - MQTT_USER=[Broker Username]
      - MQTT_PASS=[Broker Password]
      - DEBUG_MODE=False
      - REGION=[* for any or region name)
      - NOTIFIERS=[Apprise notifiers]
      - INCLUDE_TEST_ALERTS=[False|True]
      - GREEN_API_INSTANCE = #GREEN_API_INSTANCE
      - GREEN_API_TOKEN = #GREEN_API_TOKEN
      - WHATSAPP_NUMBER = #WHATSAPP_NUMBER
    restart: unless-stopped

Adding Sensor in Home-Assistant

Get full json (including date and id)

  - platform: mqtt
    name: "Red Alert"
    state_topic: "/redalert/"
    # unit_of_measurement: '%'
    icon: fas:broadcast-tower
    value_template: "{{ value_json }}"
    qos: 1

Get json with alert areas only

  - platform: mqtt
    name: "Red Alert"
    state_topic: "/redalert/"
    # unit_of_measurement: '%'
    icon: fas:broadcast-tower
    value_template: "{{ value_json.data }}"
    qos: 1

Alaram state (Value will be on/off)

  - platform: mqtt
    name: "Red Alert"
    state_topic: "/redalert/alarm"
    icon: fas:broadcast-tower
    value_template: "{{ value_json }}"
    qos: 1

redalert's People

Contributors

Stargazers

Watchers

Forkers

danhajduk dmatik dimagoltsman guykh wintrov rotem925 elade ofir29200

redalert's Issues

/usr/bin/python3: no such file or directory

Tried running with the image in the dockerhub and i recive this error

docker run -e MQTT_HOST="192.168.3.100" -e MQTT_PORT="1883" -e MQTT_USER="username" -e MQTT_PASS="password" -e DEBUG_MODE="True" --rm techblog/redalert:latest

docker: Error response from daemon: OCI runtime create failed: container_linux.go:346: starting container process caused "exec: "/usr/bin/python3": stat /usr/bin/python3: no such file or directory": unknown.

thnx

the mqtt template sensor is sending the data as test and not as json

when I set this sensor

platform: mqtt
name: "Red Alert"
state_topic: "/redalert/"
icon: fas:broadcast-tower
value_template: "{{ value_json }}"
qos: 1
I am getting UNKNOWN.

when I changes it to this
value_template: "{{ value }}"
it started to work.

Bad default variable parameters setting

https://github.com/t0mer/Redalert/blob/master/redalert.py#L29

But in log I see:

17:32:17.275 | INFO     | __main__:<module>:29 - Monitoring alerts for := *

So, in this case (running from bash in container):

>>> region = os.getenv('REGION')
>>> region
'= *'

Solved by #8

MQTT /redalert/alarm is always off

Hi, I use this service on docker, but even when I set the region to *, and even though I see the alert in the container logs, the /redalert/alarm topic always return off, and /redalert topic return "No active alerts" (when there is alarm).
What could be the reason for this?

fix typing error

hi,
on the docker-compose from hub example in the readme

MQTT_HOST=[Broker Address] needs one more space
took me sometime to realize why it's not working for me.

thank you for the great work you are doing...

Homebridge compatibility

amazing idea!
but could you please make it available as homebridge plugin?
should be very similar to that one.

URLs not accessible?

Hi Tomer,
Thank you for your greet effort on this project, awesome idea!

I tried to understand where can I get the REGION value from and I noticed both URLS (with debug or not) are not accessible from my Chrome broswer, is that OK or the script is not working at the moment?

The URLs I tried to browse to are:
https://techblog.co.il/alerts.json (got connection refused)
https://www.oref.org.il/WarningMessages/alert/alerts.json (got Access Denied)

Thanks.

Connection refused - Not authorized, disconnection reason 5

Hi Tomer,

I see the following log:

What am I missing?
Thanks.

Question - What's clearing the id from the "alerts" variable after an alarm is fired?

Tech question I was wondering about and would love yourhelp in understanding -

line 129 - alerts.append(alert["id"])
Where does the "alerts" variable being cleared after that?
Besides the initialization of this variable I haven't seen any code that changes it