Femto::Plan Namespace Reference

Classes
struct	Command

Functions
GPSCommandSequence	sequence (std::span< const Command > commands)
GPSCommandSequence	fixedBase (const GPSEllipsoidPosition &position)
	ELLIPSOID_HEIGHTS, FIX_POSITION for position, then GGA_OUTPUT.

Variables
constexpr std::chrono::milliseconds	RESPONSE_TIMEOUT {200}
	Per attempt, for every command.
constexpr std::string_view	REJECTED = "<ERROR"
constexpr unsigned	BAUD = 115200
	The link rate unless one is selected or detected, and the only rate receiver detection probes.
constexpr std::array	BAUD_RATES {BAUD}
constexpr Command	VERSION {"VERSION\r\n", "<VERSION OK"}
	Identifies the receiver without changing it, so receiver detection probes with it alone.
constexpr std::array	IDENTIFY
	Stops every log on this port and identifies the receiver, in up to IDENTIFY_ROUNDS rounds.
constexpr unsigned	IDENTIFY_ROUNDS = 2
constexpr Command	GGA_OUTPUT {"LOG GPGGA 1 \r\n", "<LOG OK"}
	GGA output; the base station uses it only to observe the survey-in.
constexpr unsigned	AVERAGED_POSITION_QUALITY = 7
	GGA fix quality of a position the receiver holds fixed: position averaging finished.
constexpr std::array	SURVEY_IN
	Survey-in base: receiver position averaging. A GGA fix of quality 7 completes it, and RTCM_OUTPUT follows.
constexpr Command	ELLIPSOID_HEIGHTS {"UNDULATION USER 0\r\n", "UNDULATION OK"}
constexpr std::string_view	FIX_POSITION_ACCEPTED = "FIX OK"
constexpr std::array	RTCM_OUTPUT
	RTCM3 output once the base position is known.

Detailed Description

Femtomes receiver configuration as data, in the order it is sent. Replies are ASCII text that need not be NMEA sentences, so each command is acknowledged by its reply text in the raw stream and rejected by REJECTED.

Function Documentation

fixedBase()

GPSCommandSequence Femto::Plan::fixedBase

(

const GPSEllipsoidPosition &

position

)

ELLIPSOID_HEIGHTS, FIX_POSITION for position, then GGA_OUTPUT.

Definition at line 33 of file FemtoPlan.cc.

References ELLIPSOID_HEIGHTS, FIX_POSITION_ACCEPTED, GGA_OUTPUT, gpsCommand(), gpsFixedDecimal(), and RESPONSE_TIMEOUT.

sequence()

GPSCommandSequence Femto::Plan::sequence

(

std::span< const Command >

commands

)

Definition at line 24 of file FemtoPlan.cc.

References GPSCommandSequence::steps.

Variable Documentation

AVERAGED_POSITION_QUALITY

constexpr unsigned Femto::Plan::AVERAGED_POSITION_QUALITY = 7

inlineconstexpr

GGA fix quality of a position the receiver holds fixed: position averaging finished.

Definition at line 45 of file FemtoPlan.h.

BAUD

constexpr unsigned Femto::Plan::BAUD = 115200

inlineconstexpr

The link rate unless one is selected or detected, and the only rate receiver detection probes.

Definition at line 29 of file FemtoPlan.h.

BAUD_RATES

constexpr std::array Femto::Plan::BAUD_RATES {BAUD}

inlineconstexpr

Definition at line 30 of file FemtoPlan.h.

ELLIPSOID_HEIGHTS

constexpr Command Femto::Plan::ELLIPSOID_HEIGHTS {"UNDULATION USER 0\r\n", "UNDULATION OK"}

inlineconstexpr

FIX POSITION takes a mean sea level height; a zero geoid separation makes that the ellipsoid height. The receiver requires it before FIX POSITION.

Definition at line 55 of file FemtoPlan.h.

Referenced by fixedBase().

FIX_POSITION_ACCEPTED

constexpr std::string_view Femto::Plan::FIX_POSITION_ACCEPTED = "FIX OK"

inlineconstexpr

Fixed base (see fixedBase()): ELLIPSOID_HEIGHTS, "FIX POSITION <latitude> <longitude> <height>" with the position in degrees and ellipsoid height in metres, GGA_OUTPUT, then RTCM_OUTPUT.

Definition at line 59 of file FemtoPlan.h.

Referenced by fixedBase().

GGA_OUTPUT

constexpr Command Femto::Plan::GGA_OUTPUT {"LOG GPGGA 1 \r\n", "<LOG OK"}

inlineconstexpr

GGA output; the base station uses it only to observe the survey-in.

Definition at line 43 of file FemtoPlan.h.

Referenced by fixedBase().

IDENTIFY

constexpr std::array Femto::Plan::IDENTIFY

inlineconstexpr

Initial value:

{
    Command{"UNLOGALL THISPORT\r\n", "<UNLOGALL OK"},
    VERSION,
}

Stops every log on this port and identifies the receiver, in up to IDENTIFY_ROUNDS rounds.

Definition at line 36 of file FemtoPlan.h.

IDENTIFY_ROUNDS

constexpr unsigned Femto::Plan::IDENTIFY_ROUNDS = 2

inlineconstexpr

Definition at line 40 of file FemtoPlan.h.

REJECTED

constexpr std::string_view Femto::Plan::REJECTED = "<ERROR"

inlineconstexpr

Definition at line 26 of file FemtoPlan.h.

RESPONSE_TIMEOUT

constexpr std::chrono::milliseconds Femto::Plan::RESPONSE_TIMEOUT {200}

inlineconstexpr

Per attempt, for every command.

Definition at line 25 of file FemtoPlan.h.

Referenced by fixedBase().

RTCM_OUTPUT

constexpr std::array Femto::Plan::RTCM_OUTPUT

inlineconstexpr

Initial value:

{
    Command{"LOG RTCM 1\r\n", "<LOG OK"},
}

RTCM3 output once the base position is known.

Definition at line 62 of file FemtoPlan.h.

SURVEY_IN

constexpr std::array Femto::Plan::SURVEY_IN

inlineconstexpr

Initial value:

{
    Command{"POSAVE ON \r\n", "<POSAVE OK"},
    GGA_OUTPUT,
}

Survey-in base: receiver position averaging. A GGA fix of quality 7 completes it, and RTCM_OUTPUT follows.

Definition at line 48 of file FemtoPlan.h.

VERSION

constexpr Command Femto::Plan::VERSION {"VERSION\r\n", "<VERSION OK"}

inlineconstexpr

Identifies the receiver without changing it, so receiver detection probes with it alone.

Definition at line 33 of file FemtoPlan.h.