Skip to main content

Python connector for Hoppie's ACARS service

Project description

hoppie-connector

License PyPI - Version

The hoppie-connector project is an API implementation for Jeroen Hoppenbrouwers' "Hoppie's ACARS" services for online multiplayer flight simulation. It can be used to create custom flight tracking and dispatch systems, or serve as a basis for airborne station implementations!

Installation

A pre-built package is hosted on PyPI and can be installed and updated using the pip utility:

pip install -U hoppie-connector

Usage Example

from hoppie_connector import HoppieConnector, HoppieError

cnx = HoppieConnector('<your callsign>', '<your logon code>')

try:
    # Send a telex message
    cnx.send_telex('<other callsign>', '<message>')

    # Fetch and print incoming messages
    messages, delay = cnx.peek()
    for m_id, msg in messages: 
        print(f"Message {m_id}: {msg}")
except HoppieError as e:
    print(e)

[!NOTE] In order to minimize unnecessary server load, keep the idle polling rate to at most once every 60 seconds. During active communication, the polling rate may be temporarily increased to once every 20 seconds.[^1]

Documentation

A more comprehensive documentation is currently in development on this project's GitHub Wiki.

Acknowledgements

Great thanks to Jeroen Hoppenbrouwers for creating and maintaining the "Hoppie's ACARS" services.

Licensing

The contents of this repository are licensed under the MIT License. The full license text is provided in the LICENSE file.

SPDX-License-Identifier: MIT

[^1]: "ACARS Server API". www.hoppie.nl. Retrieved April 3, 2024.

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

hoppie_connector-0.2.0.tar.gz (27.8 kB view details)

Uploaded Source

Built Distribution

hoppie_connector-0.2.0-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

Details for the file hoppie_connector-0.2.0.tar.gz.

File metadata

  • Download URL: hoppie_connector-0.2.0.tar.gz
  • Upload date:
  • Size: 27.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for hoppie_connector-0.2.0.tar.gz
Algorithm Hash digest
SHA256 83fce1eb2996d3531493bfb76dfe17bc74116108081532e9a38dd7f9224d723f
MD5 69491c2651c80f8a2ed82059dd7d3380
BLAKE2b-256 495798559f5b266afb6c9928d72de3af50982ab93a7fefbabb643204ae491b69

See more details on using hashes here.

File details

Details for the file hoppie_connector-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for hoppie_connector-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 72787b17424e3d61672bd68bae44b931c1c84275e58a74e749bcf13c726ddb3f
MD5 81e87323a030ffc57d7bdc72ce16534e
BLAKE2b-256 b9cd6461bdd2975b604f916ff5e671a0ff9ce402860433f9d7044bed679f9996

See more details on using hashes here.

Supported by

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