Kerbal Simpit Compound Messages

Structs for compound message types.

Functions

altitudeMessage parseAltitude(byte msg[])

Parse a message containing Altitude data.

Return
altitudeMessage A formatted altitudeMessage struct.
Parameters
  • msg: The byte array of the message body.

apsidesMessage parseApsides(byte msg[])

Parse a message containing Apsides data.

Return
apsidesMessage A formatted apsidesMessage struct.

apsidesTimeMessage parseApsidesTime(byte msg[])

Parse a message containing Apsides Time data.

Return
apsidesTimeMessage A formatted apsidesTimeMessage struct.

resourceMessage parseResource(byte msg[])

Parse a message countaining Resource data.

Return
resourceMessage A formatted resourceMessage struct.

velocityMessage parseVelocity(byte msg[])

Parse a message containing Velocity data.

Return
velocityMessage A formatted velocityMessage struct.

targetMessage parseTarget(byte msg[])

Parse a message containing Target data.

Return
targetMessage A formatted targetMessage struct.

airspeedMessage parseAirspeed(byte msg[])

Parse a message containing Airspeed data.

Return
airspeedMessage a formatted airspeedMessage struct.

struct altitudeMessage
#include <PayloadStructs.h>

An Altitude message.

Public Members

float sealevel

Altitude above sea level.

float surface

Surface altitude at current position.

struct apsidesMessage
#include <PayloadStructs.h>

An Apsides message.

Public Members

float periapsis

Current vessel’s orbital periapsis.

float apoapsis

Current vessel’s orbital apoapsis.

struct apsidesTimeMessage
#include <PayloadStructs.h>

An Apsides Time message.

Public Members

int32_t periapsis
int32_t apoapsis

Time until the current vessel’s orbital periapsis, in seconds.

struct resourceMessage
#include <PayloadStructs.h>

A Resource message.

All resource messages use this struct for sending data.

Public Members

float total

Maximum capacity of the resource.

float available

Current resource level.

struct velocityMessage
#include <PayloadStructs.h>

A Velocity message.

Public Members

float orbital

Orbital velocity.

float surface

Surface velocity.

float vertical

Vertical velocity.

struct targetMessage
#include <PayloadStructs.h>

A Target information message.

Public Members

float distance

Distance to target.

float velocity

Velocity relative to target.

struct airspeedMessage
#include <PayloadStructs.h>

An Airspeed information message.

Public Members

float IAS

Indicated airspeed.

float mach

Mach number.

struct rotationMessage
#include <PayloadStructs.h>

A vessel rotation message.

This struct contains information about vessel rotation commands.

Public Members

int16_t pitch

Vessel pitch.

int16_t roll

Vessel roll.

int16_t yaw

Vessel yaw.

byte mask

The mask indicates which elements are intentionally set.

Unset elements should be ignored. It should be one or more of:

  • 1: pitch
  • 2: roll
  • 4: yaw

struct translationMessage
#include <PayloadStructs.h>

A vessel translation message.

This struct contains information about vessel translation commands.

Public Members

int16_t X

Translation along the X axis.

int16_t Y

Translation along the Y axis.

int16_t Z

Translation along the Z axis.

byte mask

The mask indicates which elements are intentionally set.

Unset elements should be ignored. It should be one or more of:

  • 1: X
  • 2: Y
  • 4: Z

struct wheelMessage
#include <PayloadStructs.h>

A wheel control message.

This struct contains information about wheel steering and throttle.

Public Members

int16_t steer

Wheel steer.

int16_t throttle

Wheel throttle.

byte mask

The mask indicates which elements are intentionally set.

Unset elements should be ignored. It should be one or more of:

  • 1: steer
  • 2: throttle


This documentation was build using ArduinoDocs.