Port BUSACCESS - LIN¶
BluePiraT access to LIN
Stimulation¶
This port has no stimulus capabilities.
Properties 🛈¶
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
Channel number |
‘1’ |
string |
Selection of channel number if there is more than one controller of same type. |
||
Bus-DB |
string |
||||
Export format |
[ONLINE] |
string |
Save signal recordings in this format |
Jobs 🛈¶
ClearFrame¶
Erases the receiving buffer of given frame
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
FrameId |
int |
Frame ID |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
ByteStream |
ByteStream |
DeregisterFrameForInbox¶
Ungeristers a frame that is being streamed to an inbox
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
FrameId |
int |
Frame ID |
|||
Inbox |
object |
Existing inbox |
GetFirstValue¶
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
FrameName |
string |
Frame name |
|||
NodeName |
string |
Name of the electronic control unit |
|||
RawValue |
False |
[False, True] |
bool |
If ‘True’, the Raw value is returned. |
|
Reset |
False |
[False, True] |
bool |
If ‘True’ the first received value will be deleted after it has been read |
|
SignalName |
string |
Signal name |
InitFrame¶
Registers the frame for use with other jobs
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
FrameId |
int |
Frame ID |
ReadFrame¶
Reads the given frame ID (use InitLinFrame before!)
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
doDelete |
False |
[False, True] |
bool |
Deletes the Frame after reading if “True” |
|
FrameId |
int |
Frame ID |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
ByteStream |
ByteStream |
ReadFrameEx¶
Reads the given frame ID (use InitLinFrame before!)
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
doDelete |
False |
[False, True] |
bool |
Deletes the Frame after reading if “True” |
|
FrameId |
int |
Frame ID |
Return value
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
result |
object |
LinFrame |
RegisterFrameForInbox¶
Registers a frame to be streamed to an inbox.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
FrameId |
int |
Frame ID |
|||
Inbox |
object |
Existing inbox |
|||
saveAsLinFrame |
False |
[False, True] |
bool |
If True, the frame is saved as a LinFrame object, else as a ByteStream |
ResetFirstValue¶
Erases the first received value of the given signal
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
FrameName |
string |
Frame name |
|||
NodeName |
string |
Name of the electronic control unit |
|||
SignalName |
string |
Signal name |
SendFrame¶
All in one: Set data, temporarily enable a frame, and send a master request. Frame ID must be registered in advance via the job “InitFrame”.
Parameterization
Parameter
Name |
Available if |
Default value |
Valid values |
Type |
Description |
|---|---|---|---|---|---|
checkSumMode |
‘Default’ |
[‘Enhanced’, ‘Classic’, ‘Default’] |
string |
Mode of the checksum calculation. With default the LIN version from the TBC is used for the determination. |
|
DataByteStream |
ByteStream |
data to be send |
|||
FrameId |
int |
Frame ID |