fleg
/
hswro-alarm-bot
mirror of https://git.sr.ht/~michalr/hswro-alarm-bot
1
0
Fork 0
Code
Original URL (with bug tracking etc.): https://sr.ht/~michalr/hswro-alarm-bot/
37 Commits 4 Branches 4 Tags 240 KiB
Go 100%
Go to file
Michał Rudowicz d8e67643f5 Describe index meaning 2024-03-03 14:25:34 +01:00
.build.yml Reduce build output file size 2024-02-22 16:52:58 +01:00
.gitignore Mock time functions 2024-02-11 11:51:41 +01:00
.pre-commit-config.yaml Add pre-commit to CI 2024-02-11 14:45:14 +01:00
COPYING Initial commit 2024-02-08 19:23:46 +01:00
README.md Possibility to filter by indexes 2024-02-18 19:00:49 +01:00
data_store.go Separate DataStore object to allow for querying from separate place 2024-02-28 21:38:42 +01:00
filters.go Log Satel disconnections 2024-03-03 12:59:02 +01:00
filters_test.go Separate DataStore object to allow for querying from separate place 2024-02-28 21:38:42 +01:00
go.mod Switch go-satel to my fork 2024-02-25 07:58:23 +01:00
go.sum Switch go-satel to my fork 2024-02-25 07:58:23 +01:00
main.go Get persistence file path from $STATE_DIRECTORY 2024-03-03 13:54:42 +01:00
main_test.go Get persistence file path from $STATE_DIRECTORY 2024-03-03 13:54:42 +01:00
message_contents.go Describe index meaning 2024-03-03 14:25:34 +01:00
satel_utils.go Properly close Satel connection on interrupt 2024-02-18 19:36:54 +01:00
satel_utils_test.go Possibility to filter by ChangeType 2024-02-18 18:44:08 +01:00
sender_worker.go Telegram message formatting 2024-02-19 19:52:40 +01:00
sender_worker_test.go Telegram message formatting 2024-02-19 19:52:40 +01:00
templates.go Describe index meaning 2024-03-03 14:25:34 +01:00
templates_test.go Telegram message formatting 2024-02-19 19:52:40 +01:00

README.md

Hackerspace Wroclaw Alarm Bot

builds.sr.ht status

Warning: this is a proof of concept, don't rely on it

I didn't even test it yet so no idea if it works

Usage

$ TELEGRAM_APITOKEN=YOUR_API_TOKEN ./alarm_bot --satel_addr=127.0.0.1 --satel_port=31337 --tg_chat_id=YOUR_CHAT_ID_FROM_BOTFATHER

Filtering events by change type

It's possible to filter events by change type. Use the --allowed-types=TYPE1,TYPE2,... command line parameter to do that. If that parameter is not provided, then all change types are allowed, otherwise only the provided ones will be used for notifications.

Supported types are:

  • zone-violation
  • zone-tamper
  • zone-alarm
  • zone-tamper-alarm
  • zone-alarm-memory
  • zone-tamper-alarm-memory
  • zone-bypass
  • zone-no-violation-trouble
  • zone-long-violation-trouble
  • armed-partition-suppressed
  • armed-partition
  • partition-armed-mode-2
  • partition-armed-mode-3
  • partition-with-1st-code-enter
  • partition-entry-time
  • partition-exit-time-over-10s
  • partition-exit-time-under-10s
  • partition-temporary-blocked
  • partition-blocked-guard-round
  • partition-alarm
  • partition-fire-alarm
  • partition-alarm-memory
  • partition-fire-alarm-memory
  • output
  • doors-opened
  • doors-opened-long
  • status-bit
  • trouble-part-1
  • trouble-part-2
  • trouble-part-3
  • trouble-part-4
  • trouble-part-5
  • trouble-memory-part-1
  • trouble-memory-part-2
  • trouble-memory-part-3
  • trouble-memory-part-4
  • trouble-memory-part-5
  • partition-with-violated-zones
  • zone-isolate

Filtering events by index (I guess "zone", but I'm not sure)

Use the --allowed-indexes=1,2,3,... command line parameter to set the list of allowed indexes (of course provide your own list instead of 1,2,3,...). If that parameter is not provided, then all indexes are allowed; otherwise the notification is sent for all indexes.

Debugging

Set the OMIT_TG environment variable to, well, omit sending anything over to Telegram and just see the logs instead.