Skip to main content

Ein Python Modul um die Öffentliche Feuersoftware API.

Project description

Feuersoftware

Feuersoftware is a library that allow you to interact with the Feuersoftware Connect Public API.

[!IMPORTANT]
A lot of API routes are not yet implemented. If you need a specific API route, open an issue or submit a Pull request an I try to implement it ASAP.

Example

Setup the API

from feuersoftware import FeuersoftwareAPI

TOKEN = '2xgRoQfoMGb4IveCDJIZqOO1l8hZZ5jT5mAw7SSk1otrFSq50IA2HIYB3luEpv7Vw8BWwG'\
        'Y2zV96VUkOF3FCZs2OP03qaTWF3CDrUHOKndvLIFTTgx0FCMBTFBRF1DfG4g3rs8BSMHB4'\
        '6qph1AlxOZ6parmJlp90V3GQB4EoI6DFdKE4SZeBuu46mXoaDlSmpTTS3FCpeG7oEUJVgy'\
        'pLZkZSFPRng5HdKhp6HG2XmNIMAtKTG3DAUWuKRi3cZ4JstLj05y4r7jt81g4DYXz9gVYc'\
        'UWk2pOkIZ9RPmu0s4LlaXHEK3TJlxLIUt5eHIzPUVKXyhdJDckviPsTYNfRxkpcNGd0vAb'\
        'zfzwMadgb4xaOi1v6ZpsRfXyOPgpudcnO6rwwi9TlAWNZ2075CO7HVFEP31yGhXmYsdFwj'\
        'ne3UIraWovMWHqeyv2yQLigKLePDAgXYUFqQpZ9P5ScznSMUg0ZnxS0Miy0qKe9zDYtqTk'\
        'qQVwrUGfGVFp4Ti83NJLCCGUOCmF0ovOB28mYyQIqGAi2MDaNIuAvz6HT1tGAo5nYdzOeu'

api = FeuersoftwareAPI(TOKEN)

Receive data about running operations

api.get_operations()

Start new operation

alarm_data = {
  "Start": "2025-05-15T12:19:48.909Z",
  "End": "2025-05-15T12:19:48.909Z",
  "Status": 0,
  "AlarmEnabled": True,
  "Keyword": "string",
  "Address": {
    "Street": "string",
    "HouseNumber": "string",
    "ZipCode": "string",
    "City": "string",
    "District": "string"
  },
  "Reporter": {
    "Name": "string",
    "PhoneNumber": "string"
  },
  "Position": {
    "Latitude": 0,
    "Longitude": 0
  },
  "Facts": "string",
  "Ric": "string",
  "Number": "string",
  "Source": "string",
  "Properties": [
    {
      "Key": "string",
      "Value": "string",
      "Priority": 0
    }
  ],
  "AlarmedVehicles": [
    {
      "Id": 0,
      "RadioIdentifier": "string"
    }
  ],
  "AssignedVehicles": [
    {
      "Name": "string",
      "VehicleId": 0,
      "RadioId": "string",
      "Assigned": "2025-05-15T12:19:48.909Z",
      "Alerted": "2025-05-15T12:19:48.909Z",
      "Finished": "2025-05-15T12:19:48.909Z",
      "Status1": "2025-05-15T12:19:48.909Z",
      "Status2": "2025-05-15T12:19:48.909Z",
      "Status3": "2025-05-15T12:19:48.909Z",
      "Status4": "2025-05-15T12:19:48.909Z",
      "Status7": "2025-05-15T12:19:48.909Z",
      "Status8": "2025-05-15T12:19:48.909Z"
    }
  ]
}


api.post_operation(alarm_data)

If you want to update a running operation, you can pass an argument to api.post_operation:

api.post_operation(alarm_data, update_strategy="byNumber")

update_strategy can be one of four strings: "none", "byNumber", "byAddress", "byPosition"

[!NOTE]
Only Start and Keyword are mandatory

Set vehicle status

status_data = {
  "Status": 3,
  "Position": {
    "Latitude": 47.59902386911071,
    "Longitude": 8.334801219413004
  },
  "StatusTimestamp": "2025-05-15T12:24:08.905Z",
  "PositionTimestamp": "2025-05-15T12:24:08.905Z",
  "Source": "ILS"
}

api.post_vehicle_status(radioid=12345678, status_data)

Project details


Download files

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

Source Distribution

feuersoftware-0.2.5.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

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

feuersoftware-0.2.5-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file feuersoftware-0.2.5.tar.gz.

File metadata

  • Download URL: feuersoftware-0.2.5.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for feuersoftware-0.2.5.tar.gz
Algorithm Hash digest
SHA256 3d0a2d1601ac2f262c0d4ef8ca91fe1f8d22c2601502adacf06339bc63d52659
MD5 28caf3b5ce9bdd61341b89c50fd20856
BLAKE2b-256 e8aa0cf8acadcb20476313e692e43132f474869f9ce50476573c4da08135bf00

See more details on using hashes here.

Provenance

The following attestation bundles were made for feuersoftware-0.2.5.tar.gz:

Publisher: publish-to-pypi.yaml on Bouni/feuersoftware

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

File details

Details for the file feuersoftware-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: feuersoftware-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 5.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for feuersoftware-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 043b70c6ea2c32bad1bfd9ae7f0961d98363a7fb68c1a1718b29414d9fb49b0e
MD5 5c080edc79f64d73b9c906bc23a82a47
BLAKE2b-256 092793134fb1213f26c6632ec5f320d09b5ba95cd37cba218f7ef7cf19976df5

See more details on using hashes here.

Provenance

The following attestation bundles were made for feuersoftware-0.2.5-py3-none-any.whl:

Publisher: publish-to-pypi.yaml on Bouni/feuersoftware

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page