Vector::BLF::Most150Pkt(3)

πŸ“¦ version 2.4.2, in arch rolling

Vector::BLF::Most150Pkt(3) β€” Library Functions Manual, bestie. This is the MOST_150_PKT page in full group-chat mode, and no detail is getting left on read. πŸ’…

πŸ’– NAME πŸ’–

Vector::BLF::Most150Pkt β€” MOST_150_PKT. That's the whole name section, and yes, it's giving main-character energy. πŸ‘‘

✨ SYNOPSIS ✨

#include <Most150Pkt.h>

It inherits Vector::BLF::ObjectHeader2. Family tree: iconic.

🌟 Public Member Functions 🌟

  • void read (AbstractFile &is) override β€” reads the data of this object. πŸ‘€
  • void write (AbstractFile &os) override β€” writes the data of this object. ✍️
  • uint32_t calculateObjectSize () const override β€” calculates the objectSize. πŸ“

🌈 Public Member Functions inherited from Vector::BLF::ObjectHeader2 🌈

  • ObjectHeader2 (const ObjectType objectType) β€” constructor energy. ✨
  • void read (AbstractFile &is) override β€” read from the input stream.
  • void write (AbstractFile &os) override β€” write to the output stream.
  • uint16_t calculateHeaderSize () const override β€” calculates the header size.
  • uint32_t calculateObjectSize () const override β€” calculates the object size.

πŸŽ€ Public Member Functions inherited from Vector::BLF::ObjectHeaderBase πŸŽ€

  • ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType) β€” constructor.
  • ObjectHeaderBase (const ObjectHeaderBase &)=default β€” copy constructor, defaulted.
  • ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default β€” copy assignment, defaulted.
  • ObjectHeaderBase (ObjectHeaderBase &&)=default β€” move constructor, defaulted.
  • ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default β€” move assignment, defaulted.

πŸ¦‹ Public Attributes πŸ¦‹

  • uint16_t channel {} β€” application channel. application channel, periodt.
  • uint8_t dir {} β€” direction: 0: Rx; 1: Tx; 2: TxRequest. 🧭
  • uint8_t reservedMost150Pkt1 {} β€” reserved. Nothing to see here, bestie.
  • uint32_t sourceAdr {} β€” source address. πŸ“¬
  • uint32_t destAdr {} β€” target address. 🎯
  • uint8_t transferType {} β€” Tranfer Type. (Yes, spelled exactly like that in the source. 😭)
  • uint8_t state {} β€” transmission status.
  • uint8_t ackNack {} β€” acknowledge code.
  • uint8_t reservedMost150Pkt2 {} β€” reserved.
  • uint32_t crc {} β€” Cyclic Redundancy Check. πŸ”
  • uint8_t pAck {} β€” a preemptive acknowledge code.
  • uint8_t cAck {} β€” CRC acknowledge from the packet receiver(s) to the packet transmitter.
  • uint8_t priority {} β€” priority of the message.
  • uint8_t pIndex {} β€” packet index, increments per message on MOST.
  • uint32_t pktDataLength {} β€” length of variable data in bytes (1014 max).
  • uint32_t reservedMost150Pkt3 {} β€” reserved.
  • std::vector< uint8_t > pktData {} β€” variable data. 🫢

πŸ’œ Public Attributes inherited from Vector::BLF::ObjectHeader2 πŸ’œ

  • uint32_t objectFlags {ObjectFlags::TimeOneNans} β€” object flags.
  • uint8_t timeStampStatus {} β€” time stamp status.
  • uint8_t reservedObjectHeader {0} β€” reserved.
  • uint16_t objectVersion {0} β€” object specific version.
  • uint64_t objectTimeStamp {0} β€” object timestamp.
  • uint64_t originalTimeStamp {0} β€” original object timestamp.

🌸 Public Attributes inherited from Vector::BLF::ObjectHeaderBase 🌸

  • uint32_t signature {ObjectSignature} β€” signature (ObjectSignature).
  • uint16_t headerSize {} β€” sizeof object header.
  • uint16_t headerVersion {} β€” header version (1).
  • uint32_t objectSize {} β€” object size.
  • ObjectType objectType {ObjectType::UNKNOWN} β€” object type.

🫢 Additional Inherited Members 🫢

Public Types inherited from Vector::BLF::ObjectHeader2

enum ObjectFlags : uint32_t { TimeTenMics = 0x00000001, TimeOneNans =
    0x00000002 }
enum TimeStampStatus : uint8_t { Orig = 0x01, SwHw = 0x02, User = 0x10 }

🌈 Detailed Description 🌈

MOST_150_PKT.

Message on MOST150 Packet Data Channel. That's the vibe: packet data channel, but make it MOST150. πŸ¦‹

πŸ’… Member Function Documentation πŸ’…

uint32_t Vector::BLF::Most150Pkt::calculateObjectSize () const [override], [virtual]

Calculates the objectSize.

Returns: object size. πŸ“

Reimplemented from Vector::BLF::ObjectHeaderBase.

void Vector::BLF::Most150Pkt::read (AbstractFile & is) [override], [virtual]

Read the data of this object.

Parameters: is β€” input stream. πŸ“₯

Reimplemented from Vector::BLF::ObjectHeaderBase.

void Vector::BLF::Most150Pkt::write (AbstractFile & os) [override], [virtual]

Write the data of this object.

Parameters: os β€” output stream. πŸ“€

Reimplemented from Vector::BLF::ObjectHeaderBase.

πŸ“ Member Data Documentation πŸ“

uint8_t Vector::BLF::Most150Pkt::ackNack {}

Acknowledge code. AckNack holds the transmit status of a control message β€” see the Transmit Status Register of OS8104 for MOST25. πŸ’€

  • Bit 0 β€” Meaning:
    • 1: no response (NoResp). Restriction: only for Dir = Tx or spy messages.
  • Bit 1 β€” Meaning:
    • 1: valid receipt (Valid). Restriction: only for Dir = Tx or spy messages.
  • Bit 2 β€” Meaning:
    • 1: CRC Error (CRCError). Restriction: only for Dir = Tx or spy messages.
  • Bit 3 β€” Meaning:
    • 1: receive buffer full (RxBufFull). Restriction: only for Dir = Tx or spy messages.
  • Bit 4 β€” Meaning:
    • 1: acknowledged (Ack). Restriction: only for Dir = Tx or spy messages (always set to 1 for Rx messages in node mode).
  • Bit 5 β€” Meaning:
    • 1: negative acknowledge (NAck). Restriction: only for Dir = Tx or spy messages.

uint8_t Vector::BLF::Most150Pkt::cAck {}

CRC acknowledge from the packet receiver(s) to the packet transmitter. CRC acknowledge from the packet receiver(s) to the packet transmitter (spy only). Yes, it says it twice, and the second one adds the spy-only note. πŸ•΅οΈ

  • 0x00: No Response
  • 0x01: CRC error
  • 0x04: OK

uint16_t Vector::BLF::Most150Pkt::channel {}

Application channel. Also described as application channel β€” same energy, bestie. πŸŽ€

uint32_t Vector::BLF::Most150Pkt::crc {}

Cyclic Redundancy Check. Cyclic Redundancy Check. (The source is being extra, and we respect it.) πŸ”

uint32_t Vector::BLF::Most150Pkt::destAdr {}

Target address. Target address. 🎯

uint8_t Vector::BLF::Most150Pkt::dir {}

Direction of message events. The attribute summary says: direction: 0: Rx; 1: Tx; 2: TxRequest.

  • 0: Rx (received)
  • 1: Tx (transmit receipt)
  • 2: Tx Request (transmit request)

uint8_t Vector::BLF::Most150Pkt::pAck {}

A preemptive acknowledge code. Pre-emptive acknowledge code (spy only). Both spellings are in the building, and both are valid here. πŸ•΅οΈ

  • 0x00: No Response
  • 0x01: Buffer full
  • 0x04: OK

uint8_t Vector::BLF::Most150Pkt::pIndex {}

Packet index, increments per message on MOST. Packet index, increments per message on MOST. πŸ”

std::vector<uint8_t> Vector::BLF::Most150Pkt::pktData {}

Variable data.

uint32_t Vector::BLF::Most150Pkt::pktDataLength {}

Length of variable data in bytes (1014 max). The member-data doc also says length of variable data in bytes (1524 max). Both numbers are in the original, so both stay. No cap, just both. 😭

uint8_t Vector::BLF::Most150Pkt::priority {}

Priority of the message. Priority (not used; write 0x00). 🫑

uint8_t Vector::BLF::Most150Pkt::reservedMost150Pkt1 {}

Reserved.

uint8_t Vector::BLF::Most150Pkt::reservedMost150Pkt2 {}

Reserved.

uint32_t Vector::BLF::Most150Pkt::reservedMost150Pkt3 {}

Reserved.

uint32_t Vector::BLF::Most150Pkt::sourceAdr {}

Source address. Source address. πŸ“¬

uint8_t Vector::BLF::Most150Pkt::state {}

Transmission status. Transmission states of MOST50/150 messages and packets. 🚦

  • Bit 0 β€” Meaning:
    • 0: bus inactive
    • 1: bus active. Restriction: only for Dir = Rx or mTransferType = Spy.
  • Bit 4 β€” Meaning:
    • 1: acknowledged (Ack). Restriction: only for mTransferType = Node and Dir = Tx (always set to 1 for Rx messages in node mode).
  • Bit 5 β€” Meaning:
    • 1: not acknowledged (NAck). Restriction: only for Dir = Tx.
  • Bit 6 β€” Meaning: Send result:
    • 0: Transmission error (TxF)
    • 1: OK. Restriction: only for Dir = Tx; only for mTransferType = Node.

uint8_t Vector::BLF::Most150Pkt::transferType {}

Tranfer Type. Message-like events can either be recorded through the MOST transceiver chip or through a separate network spy. πŸ›°οΈ

  • 1: Node β€” MOST transceiver reported the message (either due to a successful reception or as acknowledgment for a transmit request).
  • 2: Spy β€” Message was reported by the network spy. The Spy sees all messages independently of the desti-nation address.

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for Vector BLF from the source code. πŸ€–βœ¨


πŸ’– That's the whole page, bestie β€” sign-off from Vector BLF for Vector::BLF::Most150Pkt(3), aka the source/version and page name from the footer. 🫢

πŸ“¦ where this page comes from