Skip to main content

python-fireplan

PyPI version Run tests and lint

Ein Python Modul um die Öffentliche fireplan API.

Installation

pip install python-fireplan

Verwendung

  1. API-Key in Fireplan erzeugen Create Api Key

  2. Einen Standort Registrieren

from fireplan import Fireplan

fp = Fireplan("Mein-API-Key")
fp.register("Mein-Standort")

Alarm senden

fp.send_alarm({
  "ric": "1234567",
  "subRIC": "A",
  "einsatznrlst": "20250429001",
  "strasse": "Musterstrasse",
  "hausnummer": "23",
  "ort": "Musterhausen",
  "ortsteil": "Musterteil",
  "objektname": "Schule",
  "koordinaten": "48.6928957,9.1928973",
  "einsatzstichwort": "Probealarm",
  "zusatzinfo": "Was ist denn da los?"
})

Einsatzliste abrufen

operations = fp.get_operations_list(2024)

Einsatztagebuch abrufen

logs = fp.get_operations_log("123456","Mein-Standort")

Einsatztagebuch Eintrag anlegen

fp.add_operations_log({
  "id": 2025015,
  "einsatzNrLeitstelle": "20250429001",
  "tagebuchText": "Mein Text",
  "von": "Max Meier",
  "an": "Herbert Müller",
  "standort": "Grossbrand Fa. Heinrich",
  "typ": "Info",
  "timestamp": "2025-04-29T14:04:25.459Z"
})

FMS Status senden

fp.set_fms_status({
  "fzKennung": "1234567",
  "status": "2",
  "statusTime": "2025-04-29T14:08:22.030Z"
})

[!NOTE]
fzKennung korrespondiert mit der Spalte FZRIC unter Administration -> Optionen -> Fahrzeuge

Kalender abrufen

calendar = fp.get_calendar()

Inbound SMS

[!IMPORTANT]
Dieser API Endpoint ist momentan noch nicht implementiert.

Sonstige Dienste abrufen

other_services = fp.get_other_services(2024)

Termine abrufen

events = fp.get_events(1)

[!NOTE]
Die Kalendernummer die übergeben werden muss kann über den API Endpoint get_calendar() herausgefunden werden.

Termin anlegen

fp.add_event({
  "startDate": "2025-04-28T14:08:22.030Z",
  "endDate": "2025-04-29T14:08:22.030Z",
  "allDay": True,
  "subject": "Papiersammlung",
  "location": "Gerätehaus",
  "description": "Halbjährliche Papiersammlung",
  "jahr": "2025",
  "monat": "04",
  "kalenderID": 15
})

[!NOTE]
Die KalenderID die übergeben werden muss kann über den API Endpoint get_calendar() herausgefunden werden.

Testing

uv run pytest

Notice of Non-Affiliation and Disclaimer

We are not affiliated, associated, authorized, endorsed by, or in any way officially connected with Fireplan, or any of its subsidiaries or its affiliates. The official Fireplan website can be found at https://www.fireplan.de.

The name Fireplan as well as related names, marks, emblems and images are registered trademarks of their respective owners.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python_fireplan-0.3.4.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_fireplan-0.3.4-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file python_fireplan-0.3.4.tar.gz.

File metadata

  • Download URL: python_fireplan-0.3.4.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for python_fireplan-0.3.4.tar.gz
Algorithm Hash digest
SHA256 726f1349891ad86cec5ce7690f88a7cd826e111036e71739f0f68e06f437f1d2
MD5 3f4d7918881b31a318b90e97b2a856b6
BLAKE2b-256 0882443e6d6df63b7efcaeb980706883c7d68e1d19db7a336e8523552f6855cd

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_fireplan-0.3.4.tar.gz:

Publisher: publish-to-pypi.yml on Bouni/python-fireplan

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file python_fireplan-0.3.4-py3-none-any.whl.

File metadata

File hashes

Hashes for python_fireplan-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c92a4cdbd0d0d4333d2b346f24a0262489413e8c6341bdb1bd0353d4bdb380d4
MD5 ed9c505760e62f2b265768c34429b295
BLAKE2b-256 8f6779f55af0329e3dd884e23a75d2c9be3eac5c46bdb748a0665e02443609ca

See more details on using hashes here.

Provenance

The following attestation bundles were made for python_fireplan-0.3.4-py3-none-any.whl:

Publisher: publish-to-pypi.yml on Bouni/python-fireplan

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.3.4 This release

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.2.1

2 files

0.1.4

2 files

0.1.3

2 files

0.1.1

2 files

0.1.0

2 files

0.0.9

2 files

0.0.8

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page