Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Mvg Widget #1047

Merged
merged 5 commits into from
Jan 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 88 additions & 0 deletions docs/widgets.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ Dashy has support for displaying dynamic content in the form of widgets. There a
- [GitHub Trending](#github-trending)
- [GitHub Profile Stats](#github-profile-stats)
- [Healthchecks Status](#healthchecks status)
- [Mvg Departure](#mvg-departure)
- [Mvg Connection](#mvg-connection)
- **[Self-Hosted Services Widgets](#self-hosted-services-widgets)**
- [System Info](#system-info)
- [Cron Monitoring](#cron-monitoring-health-checks)
Expand Down Expand Up @@ -1173,6 +1175,92 @@ Display status of one or more HealthChecks project(s). Works with healthcheck.io

---

### MVG Departure

Display departure time of a MVG (Münchner Verkehrs Gesellschaft) station.

From https://www.mvg.de/impressum.html:

> [...] Die Verarbeitung unserer Inhalte oder Daten durch Dritte erfordert unsere ausdrückliche Zustimmung. Für private, nicht-kommerzielle Zwecke, wird eine gemäßigte Nutzung ohne unsere ausdrückliche Zustimmung geduldet. Jegliche Form von Data-Mining stellt keine gemäßigte Nutzung dar.[...]

In other words: Private, noncomercial, moderate use of the API is tolerated. They don’t consider data mining as moderate use. (This is not a legal advice)

#### Options

**Field** | **Type** | **Required** | **Description**
--- | --- | --- | ---
**`location`** | `string` | Required | The name of the location (exact) or the location id, startin with `de:09162:`
**`limit`** | `integer` | _Optional_ | Limit number of entries, defaults to 10.
**`title`** | `string` | _Optional_ | A custom title to be displayed.
**`header`** | `bool` | _Optional_ | Shall the title be shown?
**`filters`** | `object` | _Optional_ | Filter results
**`filters.line`** | `string/array` | _Optional_ | Filter results for given line(s).
**`filters.product`** | `string/array` | _Optional_ | Filter results for specific product (TRAM, UBAHN, SBAHN, BUS).
**`filters.destination`** | `string/object` | _Optional_ | Filter results for specific destination(s)

```yaml
- type: mvg
options:
location: Marienplatz
limit: 5
```

#### Info

- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free / Private use only
- **Host**: [MVG](https://mvg.de)
- **Privacy**: _See [MVG Datenschutz](https://www.mvg.de/datenschutz-mvg.html)_

---

### MVG Connection

Display the next connection for two addresses/coordinates, stations or POI within Munich using MVG MVG (Münchner Verkehrs Gesellschaft).

From https://www.mvg.de/impressum.html:

> [...] Die Verarbeitung unserer Inhalte oder Daten durch Dritte erfordert unsere ausdrückliche Zustimmung. Für private, nicht-kommerzielle Zwecke, wird eine gemäßigte Nutzung ohne unsere ausdrückliche Zustimmung geduldet. Jegliche Form von Data-Mining stellt keine gemäßigte Nutzung dar.[...]

In other words: Private, noncomercial, moderate use of the API is tolerated. They don’t consider data mining as moderate use. (This is not a legal advice)

#### Options

**Field** | **Type** | **Required** | **Description**
--- | --- | --- | ---
**`origin`** | `string` | Required | Origin of the connection.
**`destination`** | `string` | Required | Destination of the connection.
**`title`** | `string` | _Optional_ | A custom title to be displayed.
**`header`** | `bool` | _Optional_ | Shall the title be shown?
**`filters`** | `object` | _Optional_ | Filter results
**`filters.line`** | `string/array` | _Optional_ | Filter results for given line(s).
**`filters.product`** | `string/array` | _Optional_ | Filter results for specific product (TRAM, UBAHN, SBAHN, BUS).
**`filters.destination`** | `string/object` | _Optional_ | Filter results for specific destination(s)

```yaml
- type: mvg-connection
options:
from: Marienplatz
from: Dachauer Straße 123
header: true
filters:
product: [UBAHN]
line: [U1,U2,U4,U5]

```

#### Info

- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free / Private use only
- **Host**: [MVG](https://mvg.de)
- **Privacy**: _See [MVG Datenschutz](https://www.mvg.de/datenschutz-mvg.html)_

---


## Self-Hosted Services Widgets

### System Info
Expand Down
Loading