BW3-Core/docu/docs/modul/geocoding.md
Jan Speller 9fb7fe9ea5 threads
2020-02-24 22:15:28 +01:00

59 lines
1.1 KiB
Markdown

# <center>Geocoding</center>
---
## Beschreibung
Mit diesem Modul können einem Paket die Koordinaten eines Ortes oder einer Adresse angefügt werden.
## Externe Abhängigkeiten
- geocoder
## 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
- keine
---
## Paket Modifikationen
- `address`: gefundene Adresse
- `lat`: Latitude der Adresse
- `lon`: Longitude der Adresse
---
## Zusätzliche Wildcards
- `{ADDRESS}`: gefundene Adresse
- `{LAT}`: Latitude der Adresse
- `{LON}`: Longitude der Adresse