Allowed to send location: #853

Author: GermanBluefox

README.md

@@ -38,6 +38,7 @@ Use telegram service to communicate with ioBroker
 	### **WORK IN PROGRESS**
 -->
 ### **WORK IN PROGRESS**
+- (@GermanBluefox) A received location or venue is now written to the new state `communicate.requestLocation` as `latitude;longitude` (role `value.gps`), so it can be shown e.g. on a map
 - (@GermanBluefox) Fixed: recipients can now be mixed by username and first name in one list - a recipient without a public telegram username is matched by first name even when "store username" is active
 - (@GermanBluefox) Added the missing translations for the configuration labels (API URL, port, certificates, media quality, ...) in all languages
 - (@GermanBluefox) Robustness: all telegram API calls now catch their errors, so a failing call can no longer terminate the adapter with an unhandled promise rejection

docs/en/README.md

@@ -313,6 +313,18 @@ sendTo('telegram.0', 'send', {
 });
 ```
 
+## Receiving a location
+When a user shares a location with the bot (paperclip → location) or sends a venue, the coordinates are written to the state `telegram.INSTANCE.communicate.requestLocation` as a `latitude;longitude` string (role `value.gps`). The metadata states (`requestChatId`, `requestMessageId`, `requestUserId`) are updated as well, so you know who sent it.
+
+```javascript
+on({ id: 'telegram.0.communicate.requestLocation', change: 'any' }, obj => {
+    const [latitude, longitude] = obj.state.val.split(';').map(parseFloat);
+    const user = getState('telegram.0.communicate.requestUserId').val;
+    console.log(`User ${user} is at ${latitude}, ${longitude}`);
+    // e.g. forward the coordinates to a map widget
+});
+```
+
 ## Updating messages
 The following methods allow you to change an existing message in the message history instead of sending a new one with a result of an action. This is most useful for messages with *inline keyboards* using callback queries, but can also help reduce clutter in conversations with regular chat bots.
 

io-package.json

@@ -612,6 +612,30 @@
       },
       "native": {}
     },
+    {
+      "_id": "communicate.requestLocation",
+      "type": "state",
+      "common": {
+        "name": {
+          "en": "GPS location of last received request (latitude;longitude)",
+          "de": "GPS-Position der letzten empfangenen Anfrage (Breite;Länge)",
+          "ru": "GPS-координаты последнего полученного запроса (широта;долгота)",
+          "pt": "Localização GPS do último pedido recebido (latitude;longitude)",
+          "nl": "GPS-locatie van het laatste ontvangen verzoek (breedtegraad;lengtegraad)",
+          "fr": "Position GPS de la dernière demande reçue (latitude;longitude)",
+          "it": "Posizione GPS dell'ultima richiesta ricevuta (latitudine;longitudine)",
+          "es": "Ubicación GPS de la última solicitud recibida (latitud;longitud)",
+          "pl": "Lokalizacja GPS ostatniego otrzymanego żądania (szerokość;długość)",
+          "uk": "GPS-координати останнього отриманого запиту (широта;довгота)",
+          "zh-cn": "最后收到请求的 GPS 位置（纬度；经度）"
+        },
+        "type": "string",
+        "role": "value.gps",
+        "read": true,
+        "write": false
+      },
+      "native": {}
+    },
     {
       "_id": "communicate.response",
       "type": "state",

src/main.ts

@@ -1501,7 +1501,16 @@ class Telegram extends Adapter {
         // by `processTelegramText` (which is bound via `bot.onText`). As a result the request metadata
         // (chat id, message id, user id) would stay empty for received files. Populate it here so the
         // sender can be identified. See https://github.com/iobroker-community-adapters/ioBroker.telegram/issues/1043
-        if (msg.voice || msg.photo || msg.video || msg.video_note || msg.audio || msg.document) {
+        if (
+            msg.voice ||
+            msg.photo ||
+            msg.video ||
+            msg.video_note ||
+            msg.audio ||
+            msg.document ||
+            msg.location ||
+            msg.venue
+        ) {
             this.setState('communicate.requestChatId', { val: msg.chat.id, ack: true });
             this.setState('communicate.requestMessageId', { val: msg.message_id, ack: true });
             this.setState('communicate.requestMessageThreadId', {
@@ -1513,6 +1522,17 @@ class Telegram extends Adapter {
             }
         }
 
+        // A shared location (paperclip -> location) or a venue (location + title/address) carries a
+        // latitude/longitude. Expose it as a "latitude;longitude" GPS string so it can be shown e.g. on a
+        // vis/jarvis map. See https://github.com/iobroker-community-adapters/ioBroker.telegram/issues/853
+        const location = msg.venue?.location || msg.location;
+        if (location) {
+            this.setState('communicate.requestLocation', {
+                val: `${location.latitude};${location.longitude}`,
+                ack: true,
+            });
+        }
+
         if (msg.voice) {
             try {
                 this.saveFile(