fsd9lib 0.1.0__tar.gz

fsd9lib-0.1.0/LICENSE

@@ -0,0 +1,17 @@
+GNU AFFERO GENERAL PUBLIC LICENSE
+Version 3, 19 November 2007
+
+Copyright (C) 2025 fsd9lib contributors
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.

fsd9lib-0.1.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include LICENSE
+recursive-include src *.py

fsd9lib-0.1.0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: fsd9lib
+Version: 0.1.0
+Summary: A Python FSD (Flight Simulator Data) protocol v9 library for VATSIM-compatible pilot client connections
+Author: fsd9lib contributors
+License-Expression: AGPL-3.0
+Project-URL: Homepage, https://github.com/example/fsd9
+Project-URL: Repository, https://github.com/example/fsd9
+Keywords: fsd,flight-simulator,vatsim,fsd9,fsd9lib,aviation,atc,pilot,flight-simulation,networking,protocol
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Games/Entertainment :: Simulation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
+Requires-Dist: black>=23.0; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Dynamic: license-file
+
+# fsd9lib
+
+A Python library for the FSD (Flight Simulator Data) protocol version 9 — the classic VATSIM-compatible protocol for flight simulation networking.
+
+**Zero dependencies** — uses only Python's standard library (`asyncio`).
+
+## Features
+
+- Full FSD protocol v9 packet construction and parsing
+- PBH (Pitch/Bank/Heading) encoding/decoding
+- Radio frequency encoding/decoding
+- Async TCP connection with auto-reconnect
+- High-level `PilotClient` for crew (pilot) connections
+- Callback-based message/position/error handling
+- Complete enum types: ratings, facility types, simulator types, error codes, etc.
+
+## Installation
+
+```bash
+pip install fsd9lib
+```
+
+## Quick Start
+
+```python
+import asyncio
+from fsd9 import PilotClient, NetworkRating, SimulatorType
+
+async def main():
+    # Create a pilot client
+    client = PilotClient(
+        callsign="N7938C",
+        cid="123456",
+        password="your_vatsim_password",
+        server="eu.velocity.vatsim.net",
+        real_name="John Doe",
+        sim_type=SimulatorType.MSFS2020,
+    )
+
+    # Register callbacks
+    async def on_message(client, sender, text):
+        print(f"[{sender}] {text}")
+
+    async def on_position(client, callsign, data):
+        print(f"  {callsign} @ {data['lat']:.4f}, {data['lon']:.4f} "
+              f"FL{data['altitude_true'] // 100} "
+              f"GS={data['ground_speed']}kt "
+              f"HDG={data['heading']:.0f}°")
+
+    client.on_message = on_message
+    client.on_position = on_position
+
+    # Connect and login
+    await client.connect()
+    print(f"Connected as {client.callsign}")
+
+    # File a flight plan
+    await client.file_flight_plan(
+        flight_rules="I",
+        equipment="H/B738/L",
+        tas=450,
+        dep_airport="KLAX",
+        dest_airport="KSFO",
+        cruise_alt=35000,
+        hrs_enroute=1,
+        min_enroute=30,
+        route="VTU5 RZS STOKD SERFR SERFR3",
+    )
+
+    # Send position updates
+    await client.send_position(40.65906, -73.79891, 35000, 450, 2.0, 0.0, 90.0)
+
+    # Send a text message on frequency
+    await client.send_radio_message(122.800, "Traffic in sight")
+
+    # Keep running
+    await asyncio.sleep(60)
+    await client.disconnect()
+
+asyncio.run(main())
+```
+
+## Auto-Position Mode
+
+```python
+client = PilotClient(
+    callsign="N7938C",
+    cid="123456",
+    password="secret",
+    auto_position=True,     # Automatically send position every 5s
+    position_interval=5.0,  # Customize interval
+)
+
+await client.connect()
+
+# Set the position once — it will repeat automatically
+await client.send_position(40.659, -73.798, 35000, 450)
+```
+
+## Low-Level Packet API
+
+Build and parse individual packets without a connection:
+
+```python
+from fsd9 import packet, frequency, pbh
+
+# Pack PBH
+pbh_val = pbh.pack(pitch=2.0, bank=0.0, heading=90.0)
+pitch, bank, heading, on_ground = pbh.unpack(pbh_val)
+
+# Encode frequency
+wire = frequency.encode(122.800)  # → 22800
+mhz = frequency.decode(22800)     # → 122.800
+
+# Build packets
+login = packet.build_add_pilot("N7938C", "123456", "pass")
+pos = packet.build_pilot_position("N7938C", "N", 0o2000,
+    NetworkRating.OBS, 40.659, -73.798, 35000, 450, 2.0, 0.0, 90.0)
+```
+
+## Protocol Version
+
+This library implements **FSD protocol revision 9** (classic/legacy), which uses plaintext password authentication. It does NOT support:
+- VATSIM Auth (revision 100) — challenge-response MD5
+- VATSIM JWT (revision 101) — JWT tokens
+- VATSIM Velocity fast positions (revision 101+)
+
+## License
+
+AGPL-3.0

fsd9lib-0.1.0/README.md

@@ -0,0 +1,130 @@
+# fsd9lib
+
+A Python library for the FSD (Flight Simulator Data) protocol version 9 — the classic VATSIM-compatible protocol for flight simulation networking.
+
+**Zero dependencies** — uses only Python's standard library (`asyncio`).
+
+## Features
+
+- Full FSD protocol v9 packet construction and parsing
+- PBH (Pitch/Bank/Heading) encoding/decoding
+- Radio frequency encoding/decoding
+- Async TCP connection with auto-reconnect
+- High-level `PilotClient` for crew (pilot) connections
+- Callback-based message/position/error handling
+- Complete enum types: ratings, facility types, simulator types, error codes, etc.
+
+## Installation
+
+```bash
+pip install fsd9lib
+```
+
+## Quick Start
+
+```python
+import asyncio
+from fsd9 import PilotClient, NetworkRating, SimulatorType
+
+async def main():
+    # Create a pilot client
+    client = PilotClient(
+        callsign="N7938C",
+        cid="123456",
+        password="your_vatsim_password",
+        server="eu.velocity.vatsim.net",
+        real_name="John Doe",
+        sim_type=SimulatorType.MSFS2020,
+    )
+
+    # Register callbacks
+    async def on_message(client, sender, text):
+        print(f"[{sender}] {text}")
+
+    async def on_position(client, callsign, data):
+        print(f"  {callsign} @ {data['lat']:.4f}, {data['lon']:.4f} "
+              f"FL{data['altitude_true'] // 100} "
+              f"GS={data['ground_speed']}kt "
+              f"HDG={data['heading']:.0f}°")
+
+    client.on_message = on_message
+    client.on_position = on_position
+
+    # Connect and login
+    await client.connect()
+    print(f"Connected as {client.callsign}")
+
+    # File a flight plan
+    await client.file_flight_plan(
+        flight_rules="I",
+        equipment="H/B738/L",
+        tas=450,
+        dep_airport="KLAX",
+        dest_airport="KSFO",
+        cruise_alt=35000,
+        hrs_enroute=1,
+        min_enroute=30,
+        route="VTU5 RZS STOKD SERFR SERFR3",
+    )
+
+    # Send position updates
+    await client.send_position(40.65906, -73.79891, 35000, 450, 2.0, 0.0, 90.0)
+
+    # Send a text message on frequency
+    await client.send_radio_message(122.800, "Traffic in sight")
+
+    # Keep running
+    await asyncio.sleep(60)
+    await client.disconnect()
+
+asyncio.run(main())
+```
+
+## Auto-Position Mode
+
+```python
+client = PilotClient(
+    callsign="N7938C",
+    cid="123456",
+    password="secret",
+    auto_position=True,     # Automatically send position every 5s
+    position_interval=5.0,  # Customize interval
+)
+
+await client.connect()
+
+# Set the position once — it will repeat automatically
+await client.send_position(40.659, -73.798, 35000, 450)
+```
+
+## Low-Level Packet API
+
+Build and parse individual packets without a connection:
+
+```python
+from fsd9 import packet, frequency, pbh
+
+# Pack PBH
+pbh_val = pbh.pack(pitch=2.0, bank=0.0, heading=90.0)
+pitch, bank, heading, on_ground = pbh.unpack(pbh_val)
+
+# Encode frequency
+wire = frequency.encode(122.800)  # → 22800
+mhz = frequency.decode(22800)     # → 122.800
+
+# Build packets
+login = packet.build_add_pilot("N7938C", "123456", "pass")
+pos = packet.build_pilot_position("N7938C", "N", 0o2000,
+    NetworkRating.OBS, 40.659, -73.798, 35000, 450, 2.0, 0.0, 90.0)
+```
+
+## Protocol Version
+
+This library implements **FSD protocol revision 9** (classic/legacy), which uses plaintext password authentication. It does NOT support:
+- VATSIM Auth (revision 100) — challenge-response MD5
+- VATSIM JWT (revision 101) — JWT tokens
+- VATSIM Velocity fast positions (revision 101+)
+
+## License
+
+AGPL-3.0

fsd9lib-0.1.0/pyproject.toml

@@ -0,0 +1,55 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "fsd9lib"
+version = "0.1.0"
+description = "A Python FSD (Flight Simulator Data) protocol v9 library for VATSIM-compatible pilot client connections"
+readme = "README.md"
+license = "AGPL-3.0"
+authors = [
+    {name = "fsd9lib contributors"}
+]
+keywords = [
+    "fsd", "flight-simulator", "vatsim", "fsd9", "fsd9lib", "aviation",
+    "atc", "pilot", "flight-simulation", "networking", "protocol"
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Games/Entertainment :: Simulation",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+requires-python = ">=3.9"
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-asyncio>=0.21",
+    "black>=23.0",
+    "mypy>=1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/example/fsd9"
+Repository = "https://github.com/example/fsd9"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.black]
+line-length = 100
+target-version = ["py39"]
+
+[tool.mypy]
+python_version = "3.9"
+strict = true

fsd9lib-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

fsd9lib-0.1.0/src/fsd9/__init__.py

@@ -0,0 +1,102 @@
+"""
+FSD9 — A Python library for FSD (Flight Simulator Data) protocol v9.
+
+Provides a complete implementation of the classic FSD protocol for
+VATSIM-compatible pilot client connections. Supports protocol revision 9
+(legacy plaintext authentication).
+
+Quick start::
+
+    import asyncio
+    from fsd9 import PilotClient
+
+    async def main():
+        client = PilotClient(
+            callsign="N7938C",
+            cid="123456",
+            password="secret",
+            server="eu.velocity.vatsim.net",
+        )
+
+        async def on_msg(client, sender, text):
+            print(f"[{sender}] {text}")
+
+        client.on_message = on_msg
+
+        await client.connect()
+        await client.send_position(40.659, -73.798, 35000, 450, 2.0, 0.0, 90.0)
+        # ... do stuff ...
+        await client.disconnect()
+
+    asyncio.run(main())
+"""
+
+from .client import PilotClient
+from .connection import FSDConnection
+from .constants import (
+    Capability,
+    FacilityType,
+    FlightRules,
+    NetworkRating,
+    PilotRating,
+    Recipient,
+    ServerError,
+    SimulatorType,
+    TransponderMode,
+    FSD_DEFAULT_PORT,
+    PROTOCOL_REVISION_CLASSIC,
+    CALLSIGN_MIN_LENGTH,
+    CALLSIGN_MAX_LENGTH,
+    KNOWN_CLIENT_IDS,
+    ATC_VISUAL_RANGES,
+)
+from .errors import (
+    FSDError,
+    FSDConnectionError,
+    FSDLoginError,
+    FSDProtocolError,
+    FSDServerError,
+    FSDCallsignError,
+    FSDSquawkError,
+    FSDFrequencyError,
+)
+from . import frequency
+from . import pbh
+from . import packet
+
+__version__ = "0.1.0"
+__all__ = [
+    # Client
+    "PilotClient",
+    "FSDConnection",
+    # Enums
+    "NetworkRating",
+    "PilotRating",
+    "SimulatorType",
+    "FacilityType",
+    "TransponderMode",
+    "FlightRules",
+    "ServerError",
+    "Capability",
+    "Recipient",
+    # Constants
+    "FSD_DEFAULT_PORT",
+    "PROTOCOL_REVISION_CLASSIC",
+    "CALLSIGN_MIN_LENGTH",
+    "CALLSIGN_MAX_LENGTH",
+    "KNOWN_CLIENT_IDS",
+    "ATC_VISUAL_RANGES",
+    # Errors
+    "FSDError",
+    "FSDConnectionError",
+    "FSDLoginError",
+    "FSDProtocolError",
+    "FSDServerError",
+    "FSDCallsignError",
+    "FSDSquawkError",
+    "FSDFrequencyError",
+    # Modules
+    "frequency",
+    "pbh",
+    "packet",
+]