Send data or alerts to Telegram Messenger chat #442

t-pi · 2021-09-25T22:39:59Z

First commit sending regular data and/or alerts to Telegram messenger on phone

config via userdefines.h
send data every (N) transmissions, i.e. every N*2.5 min to Telegram channel
send local alerts also to Telegram channel

Small changes to userdefines stylecheck fixes stylecheck fix 2

ThomasWaldmann · 2021-09-26T12:14:41Z

Hmm, isn't Telegram a closed / commercial service? The client seems free, but the server? Is there only one hosted by that company?

Somehow I feel supporting Matrix (Messenger: element) would be more appropriate as they also have FOSS server.

t-pi · 2021-09-26T17:10:15Z

While Telegram has not the best of reputation with human communities, it also was one of the very first to push for an easy to use chatbot system and API. Therefore it was the easiest to implement - but also the only relatively common messenger I found at all with an Arduino library...
The clients claim to be open source and support reproducible builds (s. e.g. here: https://telegram.org/apps), thus here it is as it is. No need to use the Telegram client for anything else than making :)
That said, if you find another library e.g. for Matrix (and can point me to a decent client) I am willing to integrate as well, if within my capabilities.

ThomasWaldmann

some comments.

commenting looked strange on github (github bug), always showing me duplicate forms. strange.

hopefully this doesn't mess up everything.

multigeiger/multigeiger.ino

ThomasWaldmann · 2021-10-21T18:27:22Z

multigeiger/multigeiger.ino

@@ -37,7 +37,7 @@

 // DIP switches
 static Switches switches;
-
+float accumulated_Count_Rate = 0.0, accumulated_Dose_Rate = 0.0;


this is a bit dirty considering i just got rid of most of the global variables mess.

Agreed. But it would be equally bad style to redo the whole dose calculation with local storage of the previous state from "publish" again in "transmit". I think it might be time to merge all the activities with dose & count stuff in a single function...? Maybe we should indeed meet e.g. at ShackSpace and refactor first on the whiteboard and then directly in code?

multigeiger/transmission.cpp

ThomasWaldmann · 2021-10-21T18:40:14Z

multigeiger/transmission.cpp

+
+  static unsigned int transmitCounter = 0;
+  transmitCounter++;
+  if (transmitCounter == 27720) transmitCounter = 0;  // 27720 % 1..12 == 0


not sure i understand...

Aim was for the first numbers (i.e. 1 to 12) to avoid an hiccup (i.e. change in interval length) when the counter rolls over. As the actual time the sending is happening is slowly shifting anyway, it probably doesn't matter...
Can be resolved with a better timer handling, to avoid the dependency on the initial 2.5 min for sensor.community

i still don't understand. and you need to add the comment to the source code, not here on github or in a year nobody will remember why we have that.

will adapt to fixed interval after #444

multigeiger/transmission.cpp

multigeiger/userdefines-example.h

ThomasWaldmann · 2021-10-21T18:58:05Z

multigeiger/webconf.cpp

+iotwebconf::CheckboxParameter sendLocalAlarmToMessengerParam = iotwebconf::CheckboxParameter("Send local alarm via Messenger", "sendLocalAlarmToMessenger", sendLocalAlarmToMessenger_c, CHECKBOX_LEN, sendLocalAlarmToMessenger);
+iotwebconf::IntTParameter<int16_t> sendDataToMessengerEveryParam =
+  iotwebconf::Builder<iotwebconf::IntTParameter<int16_t>>("sendDataToMessengerEvery").
+  label("Send data via Messenger every N x 2.5min\n(0=never,24=1/h,576=1/d,4032=1/week,max:27719)").


hardcoding this would need that we remember to change this place if we ever change the 2.5min elsewhere.

Agreed. We need a better architecture for data processing handling... s. above

you can also write here "every N measurement intervals" or so and that solves this problem.

with that, one can't give specific values for 1/h, 1/d, 1/w though.

multigeiger/webconf.cpp

ThomasWaldmann

some more comments.

considering the added size for the telegram bot lib, does the code still fit onto the older devices with small flash chip?

ThomasWaldmann · 2022-01-13T18:55:31Z

multigeiger/multigeiger.ino

-    transmit_data(tubes[TUBE_TYPE].type, tubes[TUBE_TYPE].nbr, dt, hv_pulses, counts, current_cpm,
+    transmit_data(tubes[TUBE_TYPE].type, tubes[TUBE_TYPE].nbr,
+                  dt, hv_pulses, counts, current_cpm,


was this beyond some line length limit or why did you reformat this?

maybe wordwrap from my editor? will check

ThomasWaldmann · 2022-01-13T18:57:50Z

multigeiger/transmission.cpp

@@ -69,9 +71,22 @@ void setup_transmission(const char *version, char *ssid, bool loraHardware) {
  c_customsrv.wc->setCACert(ca_certs);
  c_customsrv.hc = new HTTPClient;

+  if ((strlen(telegramBotToken) < 40) || (strlen(telegramChatId) < 7))
+    sendDataToMessengerEvery = -1;


maybe "Interval" instead of "Every"?

ThomasWaldmann · 2022-01-13T19:01:07Z

multigeiger/transmission.cpp

+void transmit_userinfo(String tube_type, int tube_nbr, float tube_factor, unsigned int cpm, unsigned int accu_cpm, float accu_rate,
+                   int have_thp, float temperature, float humidity, float pressure, int wifi_status, bool alarm_status) {


indenting seems not adjusted. int directly below String?

ThomasWaldmann · 2022-01-13T19:02:24Z

multigeiger/transmission.cpp

+  // if we don't have a valid Messenger config, do not send to Messenger
+  if (sendDataToMessengerEvery < 0)
+    return;


either remove the empty line 322 or add another empty line after 325 to get consistent?

ThomasWaldmann · 2022-01-13T19:09:14Z

multigeiger/transmission.cpp

+  if (((sendDataToMessengerEvery > 0) && (transmitCounter % sendDataToMessengerEvery == 0))
+      || ((sendDataToMessengerEvery >= 0) && alarm_status)) {


this seems to be a triple use variable / in band signalling and that's bad:

it is the interval, if > 0

it means only send when alarm is on when 0

it means disabled when < 0

can we have different variables to make it better readable / configurable?

e.g. could be one for the interval and another one for the mode (disabled, always, only on alarm).

that would maybe also solve the use case "send in intervals of N" but "only when alarm is on".

ThomasWaldmann · 2022-01-13T19:12:30Z

multigeiger/transmission.cpp

+        sprintf(message, "<b>--- MULTIGEIGER ALERT ! ---</b>\n<code>%s</code> rate too high:\n%.2f nSv/h (accumulated: %.2f nSv/h)", localEspId, cpm*tube_factor*1000/60, accu_rate*1000);
+      else
+        sprintf(message, "<b>--- MULTIGEIGER ALERT ! ---</b>\n<code>%s</code> rate too high:\n%d (accumulated: %d)", localEspId, cpm, accu_cpm);


still todo.

also: the unit of measurement is missing for the lower case. "GM counts"?

ThomasWaldmann · 2022-01-13T19:13:31Z

multigeiger/transmission.cpp

+      if (tube_nbr > 0)
+        sprintf(message, "MultiGeiger <code>%s</code> rates:\n%.2f nSv/h (accumulated: %.2f nSv/h)%s", localEspId, cpm*tube_factor*1000/60, accu_rate*1000, have_thp ? thp_text : "");
+      else
+        sprintf(message, "MultiGeiger <code>%s</code> CPM:\n%d (accumulated: %d)%s", localEspId, cpm, accu_cpm, have_thp ? thp_text : "");


ThomasWaldmann · 2022-01-13T19:16:10Z

multigeiger/userdefines-example.h

+// To communicate with the Telegram Messenger on your phone you need to create a bot.
+// Starting point: https://core.telegram.org/bots
+// You will get a Bot token, please provide this via Web Config.
+// Form: "XXXXXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+// Important: Start your bot channel with the command "/start" and receive the Chat ID.
+// In order to get MultiGeiger messages to your specific chat, please provide this Chat ID via Web Config.
+// Form: "123456789"


shouldn't this be either in the form the user will see or in the documentation?

ThomasWaldmann · 2022-01-13T19:18:16Z

multigeiger/webconf.cpp

+iotwebconf::CheckboxParameter sendLocalAlarmToMessengerParam = iotwebconf::CheckboxParameter("Send local alarm via Messenger", "sendLocalAlarmToMessenger", sendLocalAlarmToMessenger_c, CHECKBOX_LEN, sendLocalAlarmToMessenger);
+iotwebconf::IntTParameter<int16_t> sendDataToMessengerEveryParam =
+  iotwebconf::Builder<iotwebconf::IntTParameter<int16_t>>("sendDataToMessengerEvery").
+  label("Send data via Messenger every N x 2.5min\n(0=never,24=1/h,576=1/d,4032=1/week,max:27719)").


with that, one can't give specific values for 1/h, 1/d, 1/w though.

ThomasWaldmann · 2022-01-13T19:24:53Z

platformio-example.ini

@@ -31,3 +31,4 @@ lib_deps=
  IotWebConf@^3.1.0
  MCCI LoRaWAN LMIC library
  h2zero/NimBLE-Arduino
+  witnessmenow/UniversalTelegramBot@^1.3.0


is it required to fix it to that version?

t-pi · 2022-02-06T17:18:41Z

Hi @ThomasWaldmann, I started a separate PR to better handle different events while processing GMC data. Hopefully this will help address some of the issues above.
Could you please have a look at #444 before I continue here?
Thanks!

Send data or alerts to Telegram Messenger chat

7b4abdc

Small changes to userdefines stylecheck fixes stylecheck fix 2

t-pi force-pushed the feature/telegram_ticker branch from f96a2d9 to 7b4abdc Compare September 25, 2021 23:11

stylecheck fixes

a59c707

Messenger and telegram config via IotWebConf

1d18895

ThomasWaldmann reviewed Oct 21, 2021

View reviewed changes

Review changes

8a5758d

ThomasWaldmann reviewed Jan 13, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Send data or alerts to Telegram Messenger chat #442

Send data or alerts to Telegram Messenger chat #442

t-pi commented Sep 25, 2021

ThomasWaldmann commented Sep 26, 2021

t-pi commented Sep 26, 2021

ThomasWaldmann left a comment

ThomasWaldmann Oct 21, 2021

t-pi Oct 24, 2021

t-pi Feb 6, 2022

ThomasWaldmann Oct 21, 2021

t-pi Oct 24, 2021

ThomasWaldmann Jan 13, 2022

t-pi Feb 6, 2022

ThomasWaldmann Oct 21, 2021

t-pi Oct 24, 2021

ThomasWaldmann Jan 13, 2022

ThomasWaldmann Jan 13, 2022

t-pi Feb 6, 2022

ThomasWaldmann left a comment

ThomasWaldmann Jan 13, 2022

t-pi Feb 6, 2022

ThomasWaldmann Jan 13, 2022

t-pi Feb 6, 2022

ThomasWaldmann Jan 13, 2022

ThomasWaldmann Jan 13, 2022

ThomasWaldmann Jan 13, 2022

ThomasWaldmann Jan 13, 2022

ThomasWaldmann Jan 13, 2022

ThomasWaldmann Jan 13, 2022

ThomasWaldmann Jan 13, 2022

ThomasWaldmann Jan 13, 2022

ThomasWaldmann Jan 13, 2022

t-pi commented Feb 6, 2022

		void transmit_userinfo(String tube_type, int tube_nbr, float tube_factor, unsigned int cpm, unsigned int accu_cpm, float accu_rate,
		int have_thp, float temperature, float humidity, float pressure, int wifi_status, bool alarm_status) {

		if (((sendDataToMessengerEvery > 0) && (transmitCounter % sendDataToMessengerEvery == 0))
		\|\| ((sendDataToMessengerEvery >= 0) && alarm_status)) {

Send data or alerts to Telegram Messenger chat #442

Are you sure you want to change the base?

Send data or alerts to Telegram Messenger chat #442

Conversation

t-pi commented Sep 25, 2021

ThomasWaldmann commented Sep 26, 2021

t-pi commented Sep 26, 2021

ThomasWaldmann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ThomasWaldmann left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

t-pi commented Feb 6, 2022