BW3-Core/docu/docs/modul/geocoding.md

53 lines
958 B
Markdown
Raw Normal View History

2020-02-22 19:08:53 +01:00
# <center>Geocoding</center>
---
## Beschreibung
Mit diesem Modul können einem Paket die Koordinaten eines Ortes oder einer Adresse angefügt werden.
## Unterstützte Alarmtypen
- Pocsag
## Resource
`geocoding`
## Konfiguration
|Feld|Beschreibung|Default|
|----|------------|-------|
apiProvider|Der Provider für das Geocoding|
apiToken|Der Api-Token fuer die Geocoding-Api|
geoRegex|Regex Capture-Group zum Herausfiltern der Adresse|
#### Verfügbare Geocoding Provider
|Name|Einstellungswert|
|----|------------|
|Mapbox|mapbox|
|Google Maps|google|
**Beispiel:**
```yaml
- type: module
name: Geocoding Module
res: geocoding
config:
apiProvider: "{{ Provider für Geocoding }}"
apiToken: "{{ API-Key für Provider }}"
regex: "((?:[^ ]*,)*?)"
```
---
## Abhängigkeiten
- geocoder
- re
---
## Paket Modifikationen
- Im Paket werden die Felder `lat` und `lng` hinterlegt
---
## Zusätzliche Wildcards
- keine