Vector::BL...pModeEvent(3)

📦 version 2.4.2, in arch rolling

💤 Vector::BLF::LinSleepModeEvent — LIN_SLEEP 💤

okay bestie, so this is a page from the Library Functions Manual and it's literally all about Vector::BLF::LinSleepModeEvent, which is the LIN_SLEEP event class. she's giving sleepy icon energy and honestly? relatable. 🦋

✨ NAME ✨

Vector::BLF::LinSleepModeEvent — LIN_SLEEP. that's it, that's the whole name. short, sweet, slays. 🎀

🌸 SYNOPSIS 🌸

#include <LinSleepModeEvent.h>

Inherits Vector::BLF::ObjectHeader. yup, she's got family. 💅

🧚 Public Types

enum Flags : uint8_t { WasAwake = 0x01, IsAwake = 0x02, External = 0x04 }

🔥 Public Types inherited from Vector::BLF::ObjectHeader

enum ObjectFlags : uint32_t { TimeTenMics = 0x00000001, TimeOneNans = 0x00000002 }

💖 Public Member Functions

  • void read (AbstractFile &is) override — read it in, bestie
  • void write (AbstractFile &os) override — write it out, bestie
  • uint32_t calculateObjectSize () const override — do the math on the object size

👑 Public Member Functions inherited from Vector::BLF::ObjectHeader

  • ObjectHeader (const ObjectType objectType, const uint16_t objectVersion=0) — the constructor, she builds
  • void read (AbstractFile &is) override
  • void write (AbstractFile &os) override
  • uint16_t calculateHeaderSize () const override — header size math
  • uint32_t calculateObjectSize () const override — object size math

🫶 Public Member Functions inherited from Vector::BLF::ObjectHeaderBase

  • ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType) — constructor numero uno
  • ObjectHeaderBase (const ObjectHeaderBase &)=default — copy constructor, default-coded and thriving
  • ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default — copy assignment, also default
  • ObjectHeaderBase (ObjectHeaderBase &&)=default — move constructor, yes she moves
  • ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default — move assignment, also default

⭐ Public Attributes

  • uint16_t channel {} — application channel
  • uint8_t reason {} — the why of it all
  • uint8_t flags {} — bit mask business
  • uint32_t reservedLinSleepModeEvent {} — reserved, don't touch, not for you 🔒

💜 Public Attributes inherited from Vector::BLF::ObjectHeader

  • uint32_t objectFlags {ObjectFlags::TimeOneNans} — object flags
  • uint16_t clientIndex {} — client index of send node
  • uint16_t objectVersion {0} — object specific version
  • uint64_t objectTimeStamp {} — 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

🦋 Detailed Description 🦋

LIN_SLEEP. periodt.

so this info event lowkey pops up at the start of a measurement — like, first day of school energy — so it can report the initial state of the LIN hardware. and then it shows up every single time the mode (awake/asleep) of the LIN hardware changes. she's the group chat notification for "bestie woke up" / "bestie went to sleep". iconic behavior honestly 😭

🎀 Member Enumeration Documentation 🎀

enum Vector::BLF::LinSleepModeEvent::Flags : uint8_t

bit values for flags. very demure, very bitmask. ✨

Enumerator

  • WasAwake — LIN "was awake".
  • IsAwake — LIN "is awake".
  • External — LIN "external".

💅 Member Function Documentation 💅

uint32_t Vector::BLF::LinSleepModeEvent::calculateObjectSize () const

[override], [virtual] — she's built different, she overrides.

calculates the objectSize. the math is mathing. 🧮

Returns object size

Reimplemented from Vector::BLF::ObjectHeaderBase.

void Vector::BLF::LinSleepModeEvent::read (AbstractFile & is)

[override], [virtual]

reads the data of this object. slurp. 🍓

Parameters is — input stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

void Vector::BLF::LinSleepModeEvent::write (AbstractFile & os)

[override], [virtual]

writes the data of this object. she's an author, she publishes. ✍️

Parameters os — output stream

Reimplemented from Vector::BLF::ObjectHeaderBase.

🔥 Member Data Documentation 🔥

uint16_t Vector::BLF::LinSleepModeEvent::channel {}

application channel. channel number where the event notified. 📢

uint8_t Vector::BLF::LinSleepModeEvent::flags {}

bit mask with bit values as following:

  • Bit 0 (LSB): indicates the state of the LIN hardware before this event occurred:
    • 1: Awake
    • 0: Asleep
  • Bit 1: indicates the current state of the LIN hardware:
    • 1: Awake
    • 0: Asleep
  • Bit 2: indicates whether this event caused by external or internal event:
    • 1: External event
    • 0: Internal event

uint8_t Vector::BLF::LinSleepModeEvent::reason {}

this value indicates the reason for an event. following values are possible:

  • 0: Start state

Transition to Sleep mode

  • 1: Go-to-Sleep frame
  • 2: Bus Idle Timeout
  • 3: Silent SleepMode command (for shortening the BusIdle Timeout)

Leaving Sleep mode:

  • 9: External Wakeup signal
  • 10: Internal Wakeup signal
  • 11: Bus traffic (can only occur if the LIN hardware does not have a Master function)

LIN hardware does not go into Sleep mode in spite of request to do so:

  • 18: Bus traffic (can only occur if the LIN hardware does not have a Master function)

uint32_t Vector::BLF::LinSleepModeEvent::reservedLinSleepModeEvent {}

reserved. mind your business bestie 🙈

🧚 Author 🧚

generated automatically by Doxygen for Vector BLF from the source code. not a human, just vibes and a parser. 🫶

okay that's the whole page!! 💖 and for the cute sign-off: this was brought to you by Vector BLF (the source/version, doing the lord's work), and the page itself is Vector::BL...pModeEvent(3) — yes the title got truncated mid-word, she's mysterious like that, we don't ask questions. no date on this one, just pure timeless energy. go take a nap, you've earned it 💤🎀🦋

📦 where this page comes from