geminipbh Namespace Reference

Namespaces
namespace	indi_driver
namespace	instrumentation

Classes
class	DcOutputTarget
class	Device
struct	DiscoveryOptions
struct	DiscoveryResult
struct	FirmwareInfo
class	GeminiProtocol
class	HeaterEnabledTarget
class	HeaterManualPowerTarget
class	HeaterModeTarget
class	OperationTarget
struct	ProbeResult
class	Result
struct	StatusFrame
struct	TelemetrySnapshot
class	UsbOutputTarget
class	ValueResult

Enumerations
enum class	ConnectionEvent { Connected , Disconnected , CommunicationFailure , ReconnectSuccess }
enum class	ConnectionState {   Disconnected , Connecting , Connected , CommunicationFailure ,   Reconnecting }
enum class	ProbeStatus {   NotTried , OpenFailed , PortBusy , IdentityTimeout ,   IdentityMismatch , IdentityMatched , FirmwareTimeout , FirmwareMalformed ,   ProtocolError , Identified , Cancelled }
enum class	OperationKind {   DcOutput , UsbOutput , HeaterEnabled , HeaterMode ,   HeaterManualPower }
enum class	Confirmation {   Confirmed , NotConfirmed , NotConfirmable , InvalidTarget ,   ValueUnavailable }
enum class	Error {   None , InvalidChannel , InvalidValue , NotConnected ,   CommunicationFailure , QueueRejected , ProtocolRejected , ValueUnavailable ,   InvalidState , Busy , Cancelled }
enum class	DewMode { Automatic , Manual , Switch }
enum class	HeaterMode { Auto , ManualPwm , BinarySwitch }

Functions
std::vector< std::string >	enumerateSerialCandidates ()
ProbeResult	probeGeminiDevice (const std::string &port, const DiscoveryOptions &options)
DiscoveryResult	discoverGeminiDevices (const DiscoveryOptions &options)
const char *	probeStatusName (ProbeStatus status)
Confirmation	confirmOperation (const DcOutputTarget &target, const TelemetrySnapshot *snapshot)
Confirmation	confirmOperation (const UsbOutputTarget &target, const TelemetrySnapshot *snapshot)
Confirmation	confirmOperation (const HeaterEnabledTarget &target, const TelemetrySnapshot *snapshot)
Confirmation	confirmOperation (const HeaterModeTarget &target, const TelemetrySnapshot *snapshot)
Confirmation	confirmOperation (const HeaterManualPowerTarget &, const TelemetrySnapshot *)
Confirmation	confirmOperation (const OperationTarget &target, const TelemetrySnapshot *snapshot)
Confirmation	confirmOperation (const OperationTarget &target, const TelemetrySnapshot &snapshot)

Enumeration Type Documentation

Confirmation

enum class geminipbh::Confirmation

strong

Enumerator
Confirmed
NotConfirmed
NotConfirmable
InvalidTarget
ValueUnavailable

Definition at line 46 of file operation_confirmation.h.

ConnectionEvent

enum class geminipbh::ConnectionEvent

strong

Enumerator
Connected
Disconnected
CommunicationFailure
ReconnectSuccess

Definition at line 29 of file connection_event.h.

ConnectionState

enum class geminipbh::ConnectionState

strong

Enumerator
Disconnected
Connecting
Connected
CommunicationFailure
Reconnecting

Definition at line 42 of file device.h.

DewMode

enum class geminipbh::DewMode

strong

Enumerator
Automatic
Manual
Switch

Definition at line 32 of file status_frame.h.

Error

enum class geminipbh::Error

strong

Enumerator
None
InvalidChannel
InvalidValue
NotConnected
CommunicationFailure
QueueRejected
ProtocolRejected
ValueUnavailable
InvalidState
Busy
Cancelled

Definition at line 32 of file result.h.

HeaterMode

enum class geminipbh::HeaterMode

strong

Enumerator
Auto
ManualPwm
BinarySwitch

Definition at line 33 of file telemetry_snapshot.h.

OperationKind

enum class geminipbh::OperationKind

strong

Enumerator
DcOutput
UsbOutput
HeaterEnabled
HeaterMode
HeaterManualPower

Definition at line 37 of file operation_confirmation.h.

ProbeStatus

enum class geminipbh::ProbeStatus

strong

Enumerator
NotTried
OpenFailed
PortBusy
IdentityTimeout
IdentityMismatch
IdentityMatched
FirmwareTimeout
FirmwareMalformed
ProtocolError
Identified
Cancelled

Definition at line 41 of file discovery.h.

Function Documentation

confirmOperation() [1/7]

Confirmation geminipbh::confirmOperation ( const DcOutputTarget &  target, const TelemetrySnapshot *  snapshot  )

inline

Definition at line 251 of file operation_confirmation.h.

confirmOperation() [2/7]

Confirmation geminipbh::confirmOperation ( const HeaterEnabledTarget &  target, const TelemetrySnapshot *  snapshot  )

inline

Definition at line 265 of file operation_confirmation.h.

confirmOperation() [3/7]

Confirmation geminipbh::confirmOperation ( const HeaterManualPowerTarget &  , const TelemetrySnapshot *    )

inline

Definition at line 279 of file operation_confirmation.h.

confirmOperation() [4/7]

Confirmation geminipbh::confirmOperation ( const HeaterModeTarget &  target, const TelemetrySnapshot *  snapshot  )

inline

Definition at line 272 of file operation_confirmation.h.

confirmOperation() [5/7]

Confirmation geminipbh::confirmOperation ( const OperationTarget &  target, const TelemetrySnapshot &  snapshot  )

inline

Definition at line 292 of file operation_confirmation.h.

confirmOperation() [6/7]

Confirmation geminipbh::confirmOperation ( const OperationTarget &  target, const TelemetrySnapshot *  snapshot  )

inline

Definition at line 284 of file operation_confirmation.h.

confirmOperation() [7/7]

Confirmation geminipbh::confirmOperation ( const UsbOutputTarget &  target, const TelemetrySnapshot *  snapshot  )

inline

Definition at line 258 of file operation_confirmation.h.

discoverGeminiDevices()

DiscoveryResult geminipbh::discoverGeminiDevices

(

const DiscoveryOptions &

options

)

Definition at line 356 of file discovery.cpp.

enumerateSerialCandidates()

std::vector< std::string > geminipbh::enumerateSerialCandidates

(

)

Definition at line 340 of file discovery.cpp.

probeGeminiDevice()

ProbeResult geminipbh::probeGeminiDevice	(	const std::string &	port,
		const DiscoveryOptions &	options
	)

Definition at line 345 of file discovery.cpp.

probeStatusName()

const char * geminipbh::probeStatusName

(

ProbeStatus

status

)

Definition at line 386 of file discovery.cpp.