Skip to main content

Crate flightrelay

Crate flightrelay 

Source
Expand description

Flight Relay Protocol (FRP) — golf launch monitor event streaming.

This crate provides message schemas and optional WebSocket transport for the Flight Relay Protocol.

§Features

  • controller — [ShotAggregator] for accumulating shot lifecycle events
  • device — (reserved for future device-side helpers)
  • client — [FrpClient] WebSocket client (connects to a device)
  • server — [FrpListener] / [FrpConnection] WebSocket server (accepts controllers)

Re-exports§

pub use error::FrpError;
pub use message::DetectionMode;
pub use message::FrpEnvelope;
pub use message::FrpEvent;
pub use message::FrpMessage;
pub use message::FrpProtocolMessage;
pub use message::Severity;
pub use types::BallFlight;
pub use types::ClubData;
pub use types::FaceImpact;
pub use types::ShotKey;
pub use units::Distance;
pub use units::Velocity;

Modules§

error
FRP error types.
message
FRP message types and parsing.
types
FRP domain types: shot key, ball flight, club data, face impact, device info.
units
Unit-tagged types for FRP distance and velocity values.

Constants§

DEFAULT_PATH
Recommended default WebSocket path for FRP connections.
DEFAULT_PORT
Recommended default port for standalone FRP connections.
DEFAULT_URL
Recommended default URL for standalone FRP connections.
SPEC_VERSION
The FRP spec version this crate implements.