Readme text expanded

raschy · Oct 30, 2024 · 1f12421 · 1f12421
1 parent f51c6cd
commit 1f12421
Show file tree

Hide file tree

Showing 3 changed files with 238 additions and 253 deletions.
diff --git a/README.md b/README.md
@@ -17,11 +17,14 @@ Fetch data from German UBA
 
 ### Getting started
 
-This adapter ...
+In this adapter, at least one environmental station from which measured values are to be collected must be entered in the configuration. The station names can be selected on the website of the Federal Environment Agency at https://www.umweltbundesamt.de/themen/luft/luftqualitaet#luftdaten (then click on 'Nearest station') using the map displayed.
+The stations always begin with 'DE', followed by the federal state 'BW' and a three-digit serial number. This identifier, e.g. 'DEBW052', must then be entered in the configuration page of the adapter (confirm with Enter). Further stations can also be added here.
 
-## Usage
+If the coordinates are maintained in the main configuration of the ioBroker, the adapter attempts to find the nearest station itself when it is first started.
 
-My text ...
+## Hint
+
+It occasionally happens that measured values cannot be retrieved. This often happens at the top of the hour because data is presumably compressed and processed internally. But even at night (around midnight) it is often not possible to retrieve the data. A log entry 'No data received' is then written as a warning. This is not a defect in the adapter but is system-related.
 
 ### DISCLAIMER
 
@@ -34,6 +37,12 @@ You can check other adapters for examples or ask in the developer community. Usi
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
+
+### **WORK IN PROGRESS**
+
+-   (raschy) Readme text expanded
+-   (raschy) Issue 1 [E254] and [W040] corrected
+
 ### 0.0.3 (2024-10-28)
 
 -   (raschy) Auto detection for location activated

diff --git a/io-package.json b/io-package.json
@@ -1,163 +1,137 @@
 {
-  "common": {
-    "name": "airquality",
-    "version": "0.0.3",
-    "news": {
-      "0.0.3": {
-        "en": "Auto detection for location activated",
-        "de": "Autoerkennung für Standort aktiviert",
-        "ru": "Автоматическое обнаружение места включения",
-        "pt": "Detecção automática para localização activada",
-        "nl": "Autodetectie voor geactiveerde locatie",
-        "fr": "Détection automatique pour l'emplacement activé",
-        "it": "Rilevamento automatico per la posizione attivata",
-        "es": "Detección automática para la ubicación activada",
-        "pl": "Automatyczne wykrywanie aktywowanej lokalizacji",
-        "uk": "Автоматичне виявлення місця розташування активованого",
-        "zh-cn": "启动位置自动检测"
-      },
-      "0.0.2": {
-        "en": "initial release",
-        "de": "erstausstrahlung",
-        "ru": "первоначальный выпуск",
-        "pt": "lançamento inicial",
-        "nl": "eerste release",
-        "fr": "libération initiale",
-        "it": "rilascio iniziale",
-        "es": "liberación inicial",
-        "pl": "początkowe zwolnienie",
-        "uk": "початковий реліз",
-        "zh-cn": "初步释放"
-      },
-      "0.0.1": {
-        "en": "initial release",
-        "de": "Erstveröffentlichung",
-        "ru": "Начальная версия",
-        "pt": "lançamento inicial",
-        "nl": "Eerste uitgave",
-        "fr": "Première version",
-        "it": "Versione iniziale",
-        "es": "Versión inicial",
-        "pl": "Pierwsze wydanie",
-        "uk": "Початкова версія",
-        "zh-cn": "首次出版"
-      }
-    },
-    "titleLang": {
-      "en": "Airquality",
-      "de": "Luftqualität",
-      "ru": "Качество воздуха",
-      "pt": "Qualidade do ar",
-      "nl": "Luchtkwaliteit",
-      "fr": "Qualité de l'air",
-      "it": "Qualità dell'aria",
-      "es": "Calidad del aire",
-      "pl": "Jakość powietrza",
-      "uk": "Якість повітря",
-      "zh-cn": "空气质量"
-    },
-    "desc": {
-      "en": "Fetch data from German UBA",
-      "de": "Daten vom deutschen UBA abrufen",
-      "ru": "Получить данные из немецкого UBA",
-      "pt": "Buscar dados do UBA alemão",
-      "nl": "Haal gegevens op van de Duitse UBA",
-      "fr": "Récupérer des données depuis l'UBA allemande",
-      "it": "Recupera i dati dall'UBA tedesca",
-      "es": "Obtener datos de la UBA alemana",
-      "pl": "Pobierz dane z niemieckiego UBA",
-      "uk": "Отримати дані з німецького UBA",
-      "zh-cn": "从德国UBA获取数据"
-    },
-    "authors": [
-      "raschy <[email protected]>"
-    ],
-    "keywords": [
-      "UBA",
-      "particles",
-      "NOx",
-      "CO2",
-      "O3"
-    ],
-    "licenseInformation": {
-      "type": "free",
-      "license": "MIT"
-    },
-    "platform": "Javascript/Node.js",
-    "icon": "airquality.png",
-    "enabled": true,
-    "extIcon": "https://raw.githubusercontent.com/raschy/ioBroker.airquality/main/admin/airquality.png",
-    "readme": "https://github.com/raschy/ioBroker.airquality/blob/main/README.md",
-    "loglevel": "info",
-    "tier": 3,
-    "mode": "daemon",
-    "type": "weather",
-    "compact": true,
-    "connectionType": "cloud",
-    "dataSource": "poll",
-    "adminUI": {
-      "config": "json"
-    },
-    "dependencies": [
-      {
-        "js-controller": ">=5.0.19"
-      }
-    ],
-    "globalDependencies": [
-      {
-        "admin": ">=5.1.13"
-      }
-    ]
-  },
-  "native": {
-    "stations": ""
-  },
-  "objects": [],
-  "instanceObjects": [
-    {
-      "_id": "info",
-      "type": "channel",
-      "common": {
-        "name": {
-          "en": "Information",
-          "de": "Informationen",
-          "ru": "Информация",
-          "pt": "Informação",
-          "nl": "Informatie",
-          "fr": "Informations",
-          "it": "Informazioni",
-          "es": "Información",
-          "pl": "Informacje",
-          "uk": "Інформація",
-          "zh-cn": "资料"
-        }
-      },
-      "native": {}
-    },
-    {
-      "_id": "info.lastUpdate",
-      "type": "state",
-      "common": {
-        "role": "date.end",
-        "name": {
-          "en": "Last update",
-          "de": "Letzte Aktualisierung",
-          "ru": "Последнее обновление",
-          "pt": "Última atualização",
-          "nl": "Laatste update",
-          "fr": "Dernière mise à jour",
-          "it": "Ultimo aggiornamento",
-          "es": "Última actualización",
-          "pl": "Ostatnia aktualizacja",
-          "uk": "Останнє оновлення",
-          "zh-cn": "上次更新"
-        },
-        "type": "number",
-        "read": true,
-        "write": false,
-        "def": 0
-      },
-      "native": {}
-    }
-  ]
-}
+	"common": {
+		"name": "airquality",
+		"version": "0.0.3",
+		"news": {
+			"0.0.3": {
+				"en": "Auto detection for location activated",
+				"de": "Autoerkennung für Standort aktiviert",
+				"ru": "Автоматическое обнаружение места включения",
+				"pt": "Detecção automática para localização activada",
+				"nl": "Autodetectie voor geactiveerde locatie",
+				"fr": "Détection automatique pour l'emplacement activé",
+				"it": "Rilevamento automatico per la posizione attivata",
+				"es": "Detección automática para la ubicación activada",
+				"pl": "Automatyczne wykrywanie aktywowanej lokalizacji",
+				"uk": "Автоматичне виявлення місця розташування активованого",
+				"zh-cn": "启动位置自动检测"
+			}
+		},
+		"titleLang": {
+			"en": "Airquality",
+			"de": "Luftqualität",
+			"ru": "Качество воздуха",
+			"pt": "Qualidade do ar",
+			"nl": "Luchtkwaliteit",
+			"fr": "Qualité de l'air",
+			"it": "Qualità dell'aria",
+			"es": "Calidad del aire",
+			"pl": "Jakość powietrza",
+			"uk": "Якість повітря",
+			"zh-cn": "空气质量"
+		},
+		"desc": {
+			"en": "Fetch data from German UBA",
+			"de": "Daten vom deutschen UBA abrufen",
+			"ru": "Получить данные из немецкого UBA",
+			"pt": "Buscar dados do UBA alemão",
+			"nl": "Haal gegevens op van de Duitse UBA",
+			"fr": "Récupérer des données depuis l'UBA allemande",
+			"it": "Recupera i dati dall'UBA tedesca",
+			"es": "Obtener datos de la UBA alemana",
+			"pl": "Pobierz dane z niemieckiego UBA",
+			"uk": "Отримати дані з німецького UBA",
+			"zh-cn": "从德国UBA获取数据"
+		},
+		"authors": [
+			"raschy <[email protected]>"
+		],
+		"keywords": [
+			"UBA",
+			"particles",
+			"NOx",
+			"CO2",
+			"O3"
+		],
+		"licenseInformation": {
+			"type": "free",
+			"license": "MIT"
+		},
+		"platform": "Javascript/Node.js",
+		"icon": "airquality.png",
+		"enabled": true,
+		"extIcon": "https://raw.githubusercontent.com/raschy/ioBroker.airquality/main/admin/airquality.png",
+		"readme": "https://github.com/raschy/ioBroker.airquality/blob/main/README.md",
+		"loglevel": "info",
+		"tier": 3,
+		"mode": "daemon",
+		"type": "weather",
+		"compact": true,
+		"connectionType": "cloud",
+		"dataSource": "poll",
+		"adminUI": {
+			"config": "json"
+		},
+		"dependencies": [
+			{
+				"js-controller": ">=5.0.19"
+			}
+		],
+		"globalDependencies": [
+			{
+				"admin": ">=5.1.13"
+			}
+		]
+	},
+	"native": {
+		"stations": ""
+	},
+	"objects": [],
+	"instanceObjects": [
+		{
+			"_id": "info",
+			"type": "channel",
+			"common": {
+				"name": {
+					"en": "Information",
+					"de": "Informationen",
+					"ru": "Информация",
+					"pt": "Informação",
+					"nl": "Informatie",
+					"fr": "Informations",
+					"it": "Informazioni",
+					"es": "Información",
+					"pl": "Informacje",
+					"uk": "Інформація",
+					"zh-cn": "资料"
+				}
+			},
+			"native": {}
+		},
+		{
+			"_id": "info.lastUpdate",
+			"type": "state",
+			"common": {
+				"role": "date.end",
+				"name": {
+					"en": "Last update",
+					"de": "Letzte Aktualisierung",
+					"ru": "Последнее обновление",
+					"pt": "Última atualização",
+					"nl": "Laatste update",
+					"fr": "Dernière mise à jour",
+					"it": "Ultimo aggiornamento",
+					"es": "Última actualización",
+					"pl": "Ostatnia aktualizacja",
+					"uk": "Останнє оновлення",
+					"zh-cn": "上次更新"
+				},
+				"type": "number",
+				"read": true,
+				"write": false,
+				"def": 0
+			},
+			"native": {}
+		}
+	]
+}