nixnet.database.lin_sched_entry

class nixnet.database._lin_sched_entry.LinSchedEntry(**kwargs: int)

Bases: DatabaseObject

Database LIN schedule entry

property collision_res_sched: LinSched | None

Get or set a LIN schedule that resolves a collision for this event-triggered entry.

This property applies only when LinSchedEntry.type is EVENT_TRIGGERED. When a collision occurs for the event-triggered entry in this schedule, the master must switch to the collision resolving schedule to transfer the unconditional frames successfully.

Raises:

XnetError – The property requires that LinSchedEntry.type be set to EVENT_TRIGGERED.

Type:

LinSched

property delay: float

Get or set the time from the start of this entry (slot) to the start of the next entry.

The property uses a float value in seconds, with the fractional part used for milliseconds or microseconds.

Type:

float

property event_id: int

Get or set the event-triggered entry identifier.

This identifier is unprotected (NI-XNET handles the protection).

This property applies only when LinSchedEntry.type is EVENT_TRIGGERED. This identifier is for the event triggered entry itself, and the first payload byte is for the protected identifier of the contained unconditional frame.

Type:

int

property frames: Iterable[Frame]

Get or set a list of frames for this LIN schedule entry.

If LinSchedEntry.type is UNCONDITIONAL, this list contains one frame, which is the single unconditional frame for this entry.

If LinSchedEntry.type is SPORADIC, this list contains one or more unconditional frames for this entry. When multiple frames are pending for this entry, the order in the list determines the priority to transmit.

If LinSchedEntry.type is EVENT_TRIGGERED, this list contains one or more unconditional frames for this entry. When multiple frames for this entry are pending to be sent by distinct slaves, this property uses the LinSchedEntry.collision_res_sched to process the frames.

Type:

list of Frame

property name: str

Get or set the name of the LIN schedule entry object.

Lowercase letters, uppercase letters, numbers, and the underscore (_) are valid characters for the short name. The space ( ), period (.), and other special characters are not supported within the name. The short name must begin with a letter (uppercase or lowercase) or underscore, and not a number. The short name is limited to 128 characters.

A schedule entry name must be unique for all entries in the same schedule.

Type:

str

property name_unique_to_cluster: str

Returns a LIN schedule entry name unique to the cluster that contains the object.

If the single name is not unique within the cluster, the name is <schedule-name>.<schedule-entry-name>.

You can pass the name to the find function to retrieve the reference to the object, while the single name is not guaranteed success in find because it may be not unique in the cluster.

Type:

str

property nc_ff_data_bytes: Iterable[int]

Get or set a list of 8 ints containing raw data for LIN node configuration.

Node configuration defines a set of services used to configure slave nodes in the cluster. Every service has a specific set of parameters coded in this int list. In the LDF, file those parameters are stored, for example, in the node (ECU) or the frame object. NI-XNET LDF reader composes those parameters to the byte values like they are sent on the bus. The LIN specification document describes the node configuration services and the mapping of the parameters to the free format bytes.

The node configuration service is executed only if LinSchedEntry.type is set to NODE_CONFIG_SERVICE.

Warning

This property is not saved to the FIBEX file. If you write this property, save the database, and reopen it, the node configuration services are not contained in the database. Writing this property is useful only in the NI-XNET session immediately following.

Type:

list of int

property sched: LinSched

Returns the LIN schedule that uses this entry.

This LIN schedule is considered this entry’s parent. You define the parent schedule when you create the entry object. You cannot change it afterwards.

Type:

LinSched

property type: LinSchedEntryType

Get or set the LIN schedule entry type.

All frames that contain a payload are UNCONDITIONAL. The LIN schedule entry type determines the mechanism for transferring frames in this entry (slot).

Type:

LinSchedEntryType