IoTFleetWise / Paginator / ListDecoderManifestSignals

ListDecoderManifestSignals#

class IoTFleetWise.Paginator.ListDecoderManifestSignals#

paginator = client.get_paginator('list_decoder_manifest_signals')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from IoTFleetWise.Client.list_decoder_manifest_signals().

Request Syntax

response_iterator = paginator.paginate(
    name='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

name (string) –
[REQUIRED]

The name of the decoder manifest to list information about.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'signalDecoders': [
        {
            'fullyQualifiedName': 'string',
            'type': 'CAN_SIGNAL'|'OBD_SIGNAL',
            'interfaceId': 'string',
            'canSignal': {
                'messageId': 123,
                'isBigEndian': True|False,
                'isSigned': True|False,
                'startBit': 123,
                'offset': 123.0,
                'factor': 123.0,
                'length': 123,
                'name': 'string'
            },
            'obdSignal': {
                'pidResponseLength': 123,
                'serviceMode': 123,
                'pid': 123,
                'scaling': 123.0,
                'offset': 123.0,
                'startByte': 123,
                'byteLength': 123,
                'bitRightShift': 123,
                'bitMaskLength': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- signalDecoders (list) –
  
  Information about a list of signals to decode.
  - (dict) –
    
    Information about a signal decoder.
    - fullyQualifiedName (string) –
      
      The fully qualified name of a signal decoder as defined in a vehicle model.
    - type (string) –
      
      The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.
    - interfaceId (string) –
      
      The ID of a network interface that specifies what network protocol a vehicle follows.
    - canSignal (dict) –
      
      Information about signal decoder using the Controller Area Network (CAN) protocol.
      - messageId (integer) –
        
        The ID of the message.
      - isBigEndian (boolean) –
        
        Whether the byte ordering of a CAN message is big-endian.
      - isSigned (boolean) –
        
        Whether the message data is specified as a signed value.
      - startBit (integer) –
        
        Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).
        
        This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.
      - offset (float) –
        
        The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset.
      - factor (float) –
        
        A multiplier used to decode the CAN message.
      - length (integer) –
        
        How many bytes of data are in the message.
      - name (string) –
        
        The name of the signal.
    - obdSignal (dict) –
      
      Information about signal decoder using the On-board diagnostic (OBD) II protocol.
      - pidResponseLength (integer) –
        
        The length of the requested data.
      - serviceMode (integer) –
        
        The mode of operation (diagnostic service) in a message.
      - pid (integer) –
        
        The diagnostic code used to request data from a vehicle for this signal.
      - scaling (float) –
        
        A multiplier used to decode the message.
      - offset (float) –
        
        The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.
      - startByte (integer) –
        
        Indicates the beginning of the message.
      - byteLength (integer) –
        
        The length of a message.
      - bitRightShift (integer) –
        
        The number of positions to shift bits in the message.
      - bitMaskLength (integer) –
        
        The number of bits to mask in a message.
- NextToken (string) –
  
  A token to resume pagination.