Skip to content

Latest commit

 

History

History
220 lines (158 loc) · 8.42 KB

README.md

File metadata and controls

220 lines (158 loc) · 8.42 KB

Logo

ioBroker.schoolfree

Number of Installations Number of Installations NPM version Downloads Known Vulnerabilities Test and Release

License Donate

This adapter uses the service Sentry.io to automatically report exceptions and code errors and new device schemas to me as the developer. More details see below!

schoolfree adapter for ioBroker

If you like it, please consider a donation:

paypal

Deutsche Beschreibung:

Schoolfree ist ein Adapter für iobroker Installationen. Mit dem Adapter lassen sich die Schulferien auswerten und in Datenpunkte übergeben. Die Datenpunkte können somit für weitere Funktionen wie Heizungssteuerungen, Rolladen- und Anwesenheitssteuerungen ausgewertet und verarbeitet werden.

Der aktuelle Bezug von Terminen für die Schulferien erfolgt über die API von https://www.mehr-schulferien.de

Aktuell werden die Schulferien und freien Tage für Deutschland unterstützt.

Folgende Datenpunkte stehen mit Schoolfree für die weitere Verarbeitung zur Verfügung:

  • info.current.end: Datum für das Ende der aktuellen Ferien
  • info.current.name: Bezeichnung der aktuellen Schulferien
  • info.current.start: Startdatum der aktuellen Ferien
  • info.next.end: Datum für das Ende der nächsten Ferien
  • info.next.name: Bezeichnung der nächsten Schulferien
  • info.next.start: Startdatum der nächsten Ferien
  • info.today: Switch für den aktuellen Status heute (true/false)
  • info.tomorrow: Switch für den aktuellen Status morgen (true/false)

English description:

Schoolfree is an adapter for iobroker installations. With the adapter, the school holidays can be evaluated and transferred to data points. The data points can thus be evaluated and processed for other functions such as heating controls, shutter and presence controls.

The current subscription for school holidays is via the API of https://www.mehr-schulferien.de

Currently, the school holidays and days off for Germany are supported.

The following data points are available for further processing with Schoolfree:

  • info.current.end: Date for the end of the current holidays
  • info.current.name: name of the current school holidays
  • info.current.start: Start date of the current holiday
  • info.next.end: Date for the end of the next holidays
  • info.next.name: name of the next school holidays
  • info.next.start: Start date of the next holiday
  • info.today: Switch for the current status today (true / false)
  • info.tomorrow: switch for the current status tomorrow (true / false)

What is Sentry.io and what is reported to the servers of that company?

Sentry.io is a service for developers to get an overview about errors from their applications. And exactly this is implemented in this adapter.

When the adapter crashes or an other Code error happens, this error message that also appears in the ioBroker log is submitted to Sentry. When you allowed iobroker GmbH to collect diagnostic data then also your installation ID (this is just a unique ID without any additional infos about you, email, name or such) is included. This allows Sentry to group errors and show how many unique users are affected by such an error. All of this helps me to provide error free adapters that basically never crashs.


Changelog

WORK IN PROGRESS

  • (simatec) eslint-config fix
  • (simatec) Dependencies updated

1.1.6 (2024-11-25)

  • (simatec) Dependencies updated
  • (simatec) Issue Action added
  • (simatec) eslint-config added

1.1.5 (2024-09-21)

  • (simatec) Dependencies updated
  • (simatec) small fix
  • (simatec) Responsive Design added

1.1.4 (2024-02-06)

  • (simatec) Dependencies updated
  • (simatec) Design Fix
  • (simatec) Gulp deleted
  • (simatec) adapter-dev added
  • (simatec) Translation updated

1.1.3 (2023-11-02)

  • (simatec) Dependencies updated
  • (simatec) test and release updated

1.1.2 (2023-09-04)

  • (simatec) Dependencies updated
  • (simatec) test and release updated
  • (simatec) Translation updated

1.1.1 (2023-03-18)

  • (simatec) Dependencies updated
  • (simatec) test and release updated

1.1.0 (2022-11-01)

  • (simatec) Dependencies updated
  • (simatec) test and release updated

1.0.1 (2021-11-18)

  • (simatec) Dependencies updated
  • (simatec) test and release updated

1.0.0 (06.05.2021)

  • (simatec) GUI revised
  • (simatec) Added support for admin5
  • (simatec) code cleaned
  • (simatec) dependencies updated
  • (simatec) Github Test and Release added

0.7.0 (27.10.2020)

  • (simatec) Changeover from request to axios for data retrieval
  • (simatec) Conversion of the code structure
  • (simatec) code cleaned
  • (simatec) dependencies updated

0.6.4 (06.07.2020)

  • (simatec) small Bugfixes

0.6.3 (02.07.2020)

  • (simatec) Bugfix API Request error

0.6.2 (27.05.2020)

  • (simatec) small Bugfixes at locations settings

0.6.1 (11.05.2020)

  • (simatec) added errorhandling for sentry.io
  • (simatec) added node 14 support

0.6.0 (04.05.2020)

  • (simatec) added new features
  • (simatec) Bugfix next day schoolfree
  • (simatec) added sentry.io
  • (simatec) added translations
  • (simatec) added error handling

0.5.1 (25.03.2020)

  • (simatec) added new features

0.5.0 (23.03.2020)

  • (simatec) added public holidays
  • (simatec) Bugfix next schoolfree for API 2.0
  • (simatec) Bugfix schoolfree-name for API 2.0

0.4.1 (22.03.2020)

  • (simatec) new query as adaptation to API v2.0
  • (simatec) Adjustment of the federal state IDs"
  • (simatec) Code fix for autochecker
  • (simatec) update Dependencies

0.4.0 (21.03.2020)

0.3.1 (28.10.2019)

  • (simatec) Fix start after install

0.3.0 (18.10.2019)

  • (simatec) end of node 6 support
  • (simatec) changed dateformat

0.2.2 (04.06.2019)

  • (simatec)new object structure

0.2.1 (14.05.2019)

  • (simatec) fix travis and appveyor

0.2.0 (13.05.2019)

  • (simatec) Add Objects for next school holiday
  • (simatec) cleaned code

0.1.0 (10.05.2019)

  • (simatec) First Beta

0.0.1 (08.05.2019)

  • (simatec) initial release

License

MIT License

Copyright (c) 2019 - 2024 simatec

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.