General Objects¶

class SystemTime(year: int, month: int, day_of_week: int, day: int, hour: int, minute: int, second: int, milliseconds: int)[source]¶

Bases: object

Parameters:

year (int)
month (int)
day_of_week (int)
day (int)
hour (int)
minute (int)
second (int)
milliseconds (int)

year: int¶

month: int¶

day_of_week: int¶

day: int¶

hour: int¶

minute: int¶

second: int¶

milliseconds: int¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

pack()[source]¶

Return type:: bytes

classmethod unpack_from(buffer, offset=0)[source]¶

Parameters:

buffer (bytes)
offset (int)

Return type:

Self

pack_into(buffer, offset)[source]¶

Parameters:

buffer (bytearray)
offset (int)

Return type:

None

classmethod from_datetime(dt=None)[source]¶

Parameters:: dt (datetime | None)
Return type:: Self

to_datetime()[source]¶

Return type:: datetime

class ObjectHeaderBase(signature: bytes, header_size: int, header_version: int, object_size: int, object_type: vblf.constants.ObjType)[source]¶

Bases: object

Parameters:

signature (bytes)
header_size (int)
header_version (int)
object_size (int)
object_type (ObjType)

SIZE: ClassVar[int] = 16¶

signature: bytes¶

header_size: int¶

header_version: int¶

object_size: int¶

object_type: ObjType¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

classmethod unpack_from(buffer, offset=0)[source]¶

Parameters:

buffer (bytes)
offset (int)

Return type:

Self

pack()[source]¶

Return type:: bytes

pack_into(buffer, offset)[source]¶

Parameters:

buffer (bytearray)
offset (int)

Return type:

None

class HeaderWithBase(base: vblf.general.ObjectHeaderBase)[source]¶

Bases: object

Parameters:: base (ObjectHeaderBase)

base: ObjectHeaderBase¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

classmethod unpack_from(buffer, offset=0)[source]¶

Parameters:

buffer (bytes)
offset (int)

Return type:

Self

pack()[source]¶

Return type:: bytes

pack_into(buffer, offset)[source]¶

Parameters:

buffer (bytearray)
offset (int)

Return type:

None

class VarObjectHeader(base: vblf.general.ObjectHeaderBase, object_flags: vblf.constants.ObjFlags, object_static_size: int, object_version: int, object_time_stamp: int)[source]¶

Bases: HeaderWithBase

Parameters:

base (ObjectHeaderBase)
object_flags (ObjFlags)
object_static_size (int)
object_version (int)
object_time_stamp (int)

SIZE: ClassVar[int] = 32¶

object_flags: ObjFlags¶

object_static_size: int¶

object_version: int¶

object_time_stamp: int¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

classmethod unpack_from(buffer, offset=0)[source]¶

Parameters:

buffer (bytes)
offset (int)

Return type:

Self

pack()[source]¶

Return type:: bytes

pack_into(buffer, offset)[source]¶

Parameters:

buffer (bytearray)
offset (int)

Return type:

None

class ObjectHeader(base: vblf.general.ObjectHeaderBase, object_flags: vblf.constants.ObjFlags, client_index: int, object_version: int, object_time_stamp: int)[source]¶

Bases: HeaderWithBase

Parameters:

base (ObjectHeaderBase)
object_flags (ObjFlags)
client_index (int)
object_version (int)
object_time_stamp (int)

SIZE: ClassVar[int] = 32¶

object_flags: ObjFlags¶

client_index: int¶

object_version: int¶

object_time_stamp: int¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

classmethod unpack_from(buffer, offset=0)[source]¶

Parameters:

buffer (bytes)
offset (int)

Return type:

Self

pack()[source]¶

Return type:: bytes

pack_into(buffer, offset)[source]¶

Parameters:

buffer (bytearray)
offset (int)

Return type:

None

classmethod new(object_size, object_type, object_flags, object_version, object_time_stamp)[source]¶

Parameters:

object_size (int)
object_type (ObjType)
object_flags (ObjFlags)
object_version (int)
object_time_stamp (int)

Return type:

Self

class ObjectWithHeader(header: HeaderType)[source]¶

Bases: Generic[HeaderType]

Parameters:: header (HeaderType)

header: HeaderType¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

pack()[source]¶

Return type:: bytes

class NotImplementedObject(header: vblf.general.HeaderWithBase, buffer: bytes)[source]¶

Bases: ObjectWithHeader[HeaderWithBase]

Parameters:

header (HeaderWithBase)
buffer (bytes)

header: HeaderWithBase¶

buffer: bytes¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

pack()[source]¶

Return type:: bytes

class FileStatistics(signature: bytes, statistics_size: int, api_number: int, application_id: vblf.constants.AppId, compression_level: int | vblf.constants.Compression, application_major: int, application_minor: int, file_size: int, uncompressed_file_size: int, object_count: int, application_build: int, measurement_start_time: vblf.general.SystemTime, last_object_time: vblf.general.SystemTime, restore_points_offset: int, reserved: bytes)[source]¶

Bases: object

Parameters:

signature (bytes)
statistics_size (int)
api_number (int)
application_id (AppId)
compression_level (int | Compression)
application_major (int)
application_minor (int)
file_size (int)
uncompressed_file_size (int)
object_count (int)
application_build (int)
measurement_start_time (SystemTime)
last_object_time (SystemTime)
restore_points_offset (int)
reserved (bytes)

SIZE: ClassVar[int] = 144¶

signature: bytes¶

statistics_size: int¶

api_number: int¶

application_id: AppId¶

compression_level: int | Compression¶

application_major: int¶

application_minor: int¶

file_size: int¶

uncompressed_file_size: int¶

object_count: int¶

application_build: int¶

measurement_start_time: SystemTime¶

last_object_time: SystemTime¶

restore_points_offset: int¶

reserved: bytes¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: FileStatistics

pack()[source]¶

Return type:: bytes

classmethod new()[source]¶

Return type:: Self

class LogContainer(header: vblf.general.ObjectHeader, data: bytes)[source]¶

Bases: ObjectWithHeader[ObjectHeader]

Parameters:

header (ObjectHeader)
data (bytes)

header: ObjectHeader¶

data: bytes¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

pack()[source]¶

Return type:: bytes

classmethod new(data, time_stamp, flags=<ObjFlags.TIME_ONE_NANS: 2>, client_index=0)[source]¶

Parameters:

data (bytes)
time_stamp (int)
flags (ObjFlags)
client_index (int)

Return type:

Self

class AppText(header: vblf.general.ObjectHeader, source: vblf.constants.AppTextSource, reserved1: int, text_length: int, reserved2: int, text: str)[source]¶

Bases: ObjectWithHeader[ObjectHeader]

Parameters:

header (ObjectHeader)
source (AppTextSource)
reserved1 (int)
text_length (int)
reserved2 (int)
text (str)

header: ObjectHeader¶

source: AppTextSource¶

reserved1: int¶

text_length: int¶

reserved2: int¶

text: str¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

pack()[source]¶

Return type:: bytes

class AppTrigger(header: vblf.general.ObjectHeader, pre_trigger_time: int, post_trigger_time: int, channel: int, flags: vblf.constants.TriggerFlag, app_specific: int)[source]¶

Bases: ObjectWithHeader[ObjectHeader]

Parameters:

header (ObjectHeader)
pre_trigger_time (int)
post_trigger_time (int)
channel (int)
flags (TriggerFlag)
app_specific (int)

header: ObjectHeader¶

pre_trigger_time: int¶

post_trigger_time: int¶

channel: int¶

flags: TriggerFlag¶

app_specific: int¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

pack()[source]¶

Return type:: bytes

class EnvironmentVariable(header: vblf.general.ObjectHeader, name_length: int, data_length: int, reserved: int, name: str, data: bytes)[source]¶

Bases: ObjectWithHeader[ObjectHeader]

Parameters:

header (ObjectHeader)
name_length (int)
data_length (int)
reserved (int)
name (str)
data (bytes)

header: ObjectHeader¶

name_length: int¶

data_length: int¶

reserved: int¶

name: str¶

data: bytes¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

pack()[source]¶

Return type:: bytes

class SystemVariable(header: vblf.general.ObjectHeader, type: vblf.constants.SysVarType, representation: int, reserved1: int, name_length: int, data_length: int, reserved2: int, name: str, data: bytes)[source]¶

Bases: ObjectWithHeader[ObjectHeader]

Parameters:

header (ObjectHeader)
type (SysVarType)
representation (int)
reserved1 (int)
name_length (int)
data_length (int)
reserved2 (int)
name (str)
data (bytes)

header: ObjectHeader¶

type: SysVarType¶

representation: int¶

reserved1: int¶

name_length: int¶

data_length: int¶

reserved2: int¶

name: str¶

data: bytes¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

pack()[source]¶

Return type:: bytes

class RealTimeClock(header: vblf.general.ObjectHeader, time: int, logging_offset: int)[source]¶

Bases: ObjectWithHeader[ObjectHeader]

Parameters:

header (ObjectHeader)
time (int)
logging_offset (int)

header: ObjectHeader¶

time: int¶

logging_offset: int¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

pack()[source]¶

Return type:: bytes

class DriverOverrun(header: vblf.general.ObjectHeader, bus_type: vblf.constants.BusType, channel: int, reserved: int)[source]¶

Bases: ObjectWithHeader[ObjectHeader]

Parameters:

header (ObjectHeader)
bus_type (BusType)
channel (int)
reserved (int)

header: ObjectHeader¶

bus_type: BusType¶

channel: int¶

reserved: int¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

pack()[source]¶

Return type:: bytes

class EventComment(header: vblf.general.ObjectHeader, commented_event_type: int, text_length: int, reserved: int, text: str)[source]¶

Bases: ObjectWithHeader[ObjectHeader]

Parameters:

header (ObjectHeader)
commented_event_type (int)
text_length (int)
reserved (int)
text (str)

header: ObjectHeader¶

commented_event_type: int¶

text_length: int¶

reserved: int¶

text: str¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

pack()[source]¶

Return type:: bytes

class GlobalMarker(header: vblf.general.ObjectHeader, commented_event_type: int, foreground_color: int, background_color: int, is_relocatable: int, reserved1: int, reserved2: int, group_name_length: int, marker_name_length: int, description_length: int, reserved3: int, reserved4: int, group_name: str, marker_name: str, description: str)[source]¶

Bases: ObjectWithHeader[ObjectHeader]

Parameters:

header (ObjectHeader)
commented_event_type (int)
foreground_color (int)
background_color (int)
is_relocatable (int)
reserved1 (int)
reserved2 (int)
group_name_length (int)
marker_name_length (int)
description_length (int)
reserved3 (int)
reserved4 (int)
group_name (str)
marker_name (str)
description (str)

header: ObjectHeader¶

commented_event_type: int¶

foreground_color: int¶

background_color: int¶

is_relocatable: int¶

reserved1: int¶

reserved2: int¶

group_name_length: int¶

marker_name_length: int¶

description_length: int¶

reserved3: int¶

reserved4: int¶

group_name: str¶

marker_name: str¶

description: str¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

pack()[source]¶

Return type:: bytes

class FunctionBus(header: vblf.general.VarObjectHeader, object_type: vblf.constants.FunctionBusType, ve_type: int, name_length: int, data_length: int, name: str, data: bytes)[source]¶

Bases: ObjectWithHeader[VarObjectHeader]

Parameters:

header (VarObjectHeader)
object_type (FunctionBusType)
ve_type (int)
name_length (int)
data_length (int)
name (str)
data (bytes)

header: VarObjectHeader¶

object_type: FunctionBusType¶

ve_type: int¶

name_length: int¶

data_length: int¶

name: str¶

data: bytes¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

pack()[source]¶

Return type:: bytes

class TriggerCondition(header: vblf.general.VarObjectHeader, state: vblf.constants.TriggerConditionStatus, trigger_block_name_length: int, trigger_condition_length: int, trigger_block_name: str, trigger_condition: str)[source]¶

Bases: ObjectWithHeader[VarObjectHeader]

Parameters:

header (VarObjectHeader)
state (TriggerConditionStatus)
trigger_block_name_length (int)
trigger_condition_length (int)
trigger_block_name (str)
trigger_condition (str)

header: VarObjectHeader¶

state: TriggerConditionStatus¶

trigger_block_name_length: int¶

trigger_condition_length: int¶

trigger_block_name: str¶

trigger_condition: str¶

classmethod unpack(buffer)[source]¶

Parameters:: buffer (bytes)
Return type:: Self

pack()[source]¶

Return type:: bytes