Back to LIN Commands
CMD_GET_FRAMES

Command: CMD_GET_FRAMES
Destination: SD_LIN
Destination Channel: 0

Description

Clients use this command to retrieve the frame IDs and names published by one or all of the nodes defined in the LDF (LIN Description File) that has been parsed.


Command Data Format

Node padding
variable 0-3 bytes

Node
The name of the node from which frame information will be returned. A special value of all will return a list of all of the defined frames. The name is a null terminated string. Event Triggered Frames and Diagnostic Frames are included only when Node is set to all.


Response Data Format

Number Frame ID Frame Name . . . padding
2 bytes 1 byte variable . . . 0-3 bytes
frame information

Number
The number of frame IDs and names to follow. (network byte order)

Frame ID
The frame ID of the frame.

Frame Name
The name of the frame as a null terminated string.

 

notes:
Frame information is returned as a pair of values (Frame ID and Frame Name) which is repeated as necessary until all of the frames for a node or all of nodes are listed.

The Frame Names are variable lengths. Each name is terminated with a null character, making it a standard C string. This enables the use of strcpy() and length() when working with the names.


Response Return Codes

RESP_OK Execution of the command was successful.
RESP_INVAL_PARAM No LDF (LIN Description File) has been parsed, the node is not defined in the LDF or too many frames are present to fit the response.
RESP_UNSUPPORTED This command is not supported on the specified channel.
RESP_UNREG The specified source channel is not registered with the server.
RESP_UNKNOWN_ERR An unknown error occurred.

|Top|