CanFrmGet

Description

This function returns the value with a given bit width out of the frame at the given position. If width or position is out of range, the return value is 0.

Prototype

CPU_INT16U CanFrmGet(CANFRM     *frm,
                     CPU_INT08U  width,
                     CPU_INT08U  pos);

Parameter

Meaning

frm

Pointer to CAN frame

width

Width of value in bits in bit in range 1..32 or byte (1, 2 or 4).

Note: Interpreting width in bit or byte depends on the configuration setting CANSIG_GRANULARITY

pos

Position of first bit, which is used in the can frame in range 0..63.or of first byte.

Note: Interpreting the position in bit or byte depends on the configuration setting CANSIG_GRANULARITY

Additional Information

Current limitation of this function: with data width of 1,2 or 4 byte the position range depends on the data width:

  • width is byte (1): 0..7
  • width is word (2): 0..6
  • width is long (4): 0..4

Return Value

Value out of the CAN frame.