# hoppie-connector
[](LICENSE) 
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](https://pypi.org/project/hoppie-connector/) and can be installed and updated using the [`pip`](https://pip.pypa.io/en/stable/getting-started/) utility:
```sh
pip install -U hoppie-connector
```
## Usage Example
```python
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](https://github.com/islandcontroller/hoppie-connector/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`](LICENSE) file.
SPDX-License-Identifier: MIT
[^1]: ["ACARS Server API"](https://www.hoppie.nl/acars/system/tech.html). *www.hoppie.nl*. Retrieved April 3, 2024.
Raw data
{
"_id": null,
"home_page": null,
"name": "hoppie-connector",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "hoppie, acars, vatsim",
"author": "islandc_",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/3d/88/c529fe8638fc1717b142ff35f966f55cdc86c6eb8397cc1a738d6fb51be8/hoppie-connector-0.1.0.tar.gz",
"platform": null,
"description": "# hoppie-connector\n\n[](LICENSE) \n\nThe *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!\n\n## Installation\n\nA pre-built package is hosted on [PyPI](https://pypi.org/project/hoppie-connector/) and can be installed and updated using the [`pip`](https://pip.pypa.io/en/stable/getting-started/) utility:\n\n```sh\npip install -U hoppie-connector\n```\n\n## Usage Example\n\n```python\nfrom hoppie_connector import HoppieConnector, HoppieError\n\ncnx = HoppieConnector('<your callsign>', '<your logon code>')\n\ntry:\n # Send a telex message\n cnx.send_telex('<other callsign>', '<message>')\n\n # Fetch and print incoming messages\n messages, delay = cnx.peek()\n for m_id, msg in messages: \n print(f\"Message {m_id}: {msg}\")\nexcept HoppieError as e:\n print(e)\n```\n\n> [!NOTE]\n> 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]\n\n## Documentation\n\nA more comprehensive documentation is currently in development on this project's [GitHub Wiki](https://github.com/islandcontroller/hoppie-connector/wiki).\n\n## Acknowledgements\n\nGreat thanks to Jeroen Hoppenbrouwers for creating and maintaining the \"*Hoppie's ACARS*\" services.\n\n## Licensing\n\nThe contents of this repository are licensed under the MIT License. The full license text is provided in the [`LICENSE`](LICENSE) file.\n\n SPDX-License-Identifier: MIT\n\n[^1]: [\"ACARS Server API\"](https://www.hoppie.nl/acars/system/tech.html). *www.hoppie.nl*. Retrieved April 3, 2024.\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Python connector for Hoppie's ACARS service",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://github.com/islandcontroller/hoppie-connector/wiki/",
"Homepage": "https://islandcontroller.github.io/hoppie-connector/",
"Issues": "https://github.com/islandcontroller/hoppie-connector/issues/",
"Repository": "https://github.com/islandcontroller/hoppie-connector.git"
},
"split_keywords": [
"hoppie",
" acars",
" vatsim"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c16654311c15508351f0ac8bd00159b4261a70488bc2f937c728f7623bed6d20",
"md5": "578d996cd22d20e819230e3d1fac3fe2",
"sha256": "7a8554446f5baa8c11d68747ba37609846313d27d2bd676f7dd16f1a711031e8"
},
"downloads": -1,
"filename": "hoppie_connector-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "578d996cd22d20e819230e3d1fac3fe2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 12099,
"upload_time": "2024-04-03T23:09:45",
"upload_time_iso_8601": "2024-04-03T23:09:45.531640Z",
"url": "https://files.pythonhosted.org/packages/c1/66/54311c15508351f0ac8bd00159b4261a70488bc2f937c728f7623bed6d20/hoppie_connector-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3d88c529fe8638fc1717b142ff35f966f55cdc86c6eb8397cc1a738d6fb51be8",
"md5": "aab89f30ba55dd5a98d612b1f49f67f2",
"sha256": "134df6a3f4f7e6e66e64b75901f0435f1c9e58ba8296b5520d8638b03d984119"
},
"downloads": -1,
"filename": "hoppie-connector-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "aab89f30ba55dd5a98d612b1f49f67f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 22459,
"upload_time": "2024-04-03T23:09:47",
"upload_time_iso_8601": "2024-04-03T23:09:47.012458Z",
"url": "https://files.pythonhosted.org/packages/3d/88/c529fe8638fc1717b142ff35f966f55cdc86c6eb8397cc1a738d6fb51be8/hoppie-connector-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-03 23:09:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "islandcontroller",
"github_project": "hoppie-connector",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hoppie-connector"
}
JSON
