mimosis Namespace Reference

Classes
class	Message
	Class for handling a 16-bit MIMOSIS message word. More...
struct	WordField
	Helper for word field decoding (bit ranges) More...

Enumerations
enum class	WordType : uint8_t {   Empty , FrameHeader , RegionHeader , PixelData ,   FrameTrailer , Spare , Unknown }
	— Word Types More...
enum class	TrailerFlags : uint8_t { FrameOverflow = 1 << 0 , RegionOverflow = 1 << 1 , SuperRegionOverflow = 1 << 2 , BufferFull = 1 << 3 }
	— Frame Trailer Flags (see format image) More...

Functions
static constexpr WordField	kPixelAddrField (0, 10)
static constexpr WordField	kPEAddrField (10, 3)
static constexpr WordField	kCodeField (13, 3)
static constexpr WordField	kRegionNumField (0, 6)
static constexpr WordField	kFrameNumField (0, 24)
static constexpr WordField	kTrailerFlagsField (8, 8)

Enumeration Type Documentation

TrailerFlags

enum class mimosis::TrailerFlags : uint8_t

strong

— Frame Trailer Flags (see format image)

Enumerator
FrameOverflow
RegionOverflow
SuperRegionOverflow
BufferFull

Definition at line 28 of file MimosisMessage.h.

WordType

enum class mimosis::WordType : uint8_t

strong

— Word Types

Enumerator
Empty	0xFCAA, specific empty word for padding
FrameHeader	0xFE00 - 0xFEFF, part of 8-word frame header
RegionHeader	0xFD00 - 0xFD3F, region header (region # in 6 lsb)
PixelData	0x0000 - 0xFBFF, pixel address (0..504 used, up to 0xFBFF)
FrameTrailer	0xFF00 - 0xFFFF, trailer (checksum, flags)
Spare	0xFC00 - 0xFC7F, unused, reserved (excluding 0xFCAA)
Unknown

Definition at line 16 of file MimosisMessage.h.

Function Documentation

kCodeField()

static constexpr WordField mimosis::kCodeField ( 13 , 3  )

staticconstexpr

kFrameNumField()

static constexpr WordField mimosis::kFrameNumField ( 0 , 24  )

staticconstexpr

kPEAddrField()

static constexpr WordField mimosis::kPEAddrField ( 10 , 3  )

staticconstexpr

kPixelAddrField()

static constexpr WordField mimosis::kPixelAddrField ( 0 , 10  )

staticconstexpr

kRegionNumField()

static constexpr WordField mimosis::kRegionNumField ( 0 , 6  )

staticconstexpr

kTrailerFlagsField()

static constexpr WordField mimosis::kTrailerFlagsField ( 8 , 8  )

staticconstexpr