Data32bitHeader are all command headers used in Data32bitPacket. More...

Inheritance diagram for Data32bitHeader:

Collaboration diagram for Data32bitHeader:

Public Member Functions
def	__new__ (cls, value, doc=None)
	overwrite to enable doc strings for enum elements as second argument. More...

Static Public Attributes
int	IN_ASYNC_TO_CHIP0

int	IN_ASYNC_TO_CHIP1

int	IN_ASYNC_TO_CHIP2

int	IN_ASYNC_TO_CHIP3

int	IN_ASYNC_TO_CHIP4

int	IN_ASYNC_TO_CHIP5

int	IN_ASYNC_TO_CHIP6

int	IN_ASYNC_TO_CHIP7

int	IN_CONF_READ_ON_REQUEST

int	IN_FREE_INSTRUCTION_SPOTS

int	IN_MAPPER_END

int	IN_MAPPER_KEY

int	IN_READ

int	IN_READ_INSTRUCTIONS

int	IN_READ_LAST

int	IN_READ_TIME

int	IN_RESET

int	IN_SET_TIME

int	IN_SPI0

int	IN_SPI1

int	IN_SPI2

int	OUT_ASYNC_FROM_CHIP0

int	OUT_ASYNC_FROM_CHIP1

int	OUT_ASYNC_FROM_CHIP2

int	OUT_ASYNC_FROM_CHIP3

int	OUT_ASYNC_FROM_CHIP4

int	OUT_ASYNC_FROM_CHIP5

int	OUT_ASYNC_FROM_CHIP6

int	OUT_ASYNC_FROM_CHIP7

int	OUT_BUFFER_LAST_READ

int	OUT_FREE_INSTRUCTION_SPOTS

int	OUT_SPI0

int	OUT_SPI1

int	OUT_SPI2

int	OUT_TIME

int	UC_CLOSE_CONNECTION

Detailed Description

Data32bitHeader are all command headers used in Data32bitPacket.

   the description explains the function of the individual commands.
   some commands ignore the value.

Definition at line 36 of file header.py.

Member Function Documentation

◆ new()

def __new__	(	cls,
		value,
		doc = `None`
	)

overwrite to enable doc strings for enum elements as second argument.

Definition at line 43 of file header.py.

Member Data Documentation

◆ IN_ASYNC_TO_CHIP0

int IN_ASYNC_TO_CHIP0

static

Initial value:

=  30, """
     sends an 0-32bit word on the ASYNC_TO_CHIP0 interface
     uses data
      - value is the word to be send, if the width is configured to >32 the MS bits are ignored
    """

Definition at line 161 of file header.py.

◆ IN_ASYNC_TO_CHIP1

int IN_ASYNC_TO_CHIP1

static

Initial value:

=  31 , """
     sends an 0-32bit word on the ASYNC_TO_CHIP1 interface
     uses data
      - value is the word to be send, if the width is configured to >32 the MS bits are ignored
    """

Definition at line 167 of file header.py.

◆ IN_ASYNC_TO_CHIP2

int IN_ASYNC_TO_CHIP2

static

Initial value:

=  32, """
     sends an 0-32bit word on the ASYNC_TO_CHIP2 interface
     uses data
      - value is the word to be send, if the width is configured to >32 the MS bits are ignored
    """

Definition at line 173 of file header.py.

◆ IN_ASYNC_TO_CHIP3

int IN_ASYNC_TO_CHIP3

static

Initial value:

=  33, """
     sends an 0-32bit word on the ASYNC_TO_CHIP3 interface
     uses data
      - value is the word to be send, if the width is configured to >32 the MS bits are ignored
    """

Definition at line 179 of file header.py.

◆ IN_ASYNC_TO_CHIP4

int IN_ASYNC_TO_CHIP4

static

Initial value:

=  34, """
     sends an 0-32bit word on the ASYNC_TO_CHIP4 interface
     uses data
      - value is the word to be send, if the width is configured to >32 the MS bits are ignored
    """

Definition at line 185 of file header.py.

◆ IN_ASYNC_TO_CHIP5

int IN_ASYNC_TO_CHIP5

static

Initial value:

=  35, """
     sends an 0-32bit word on the ASYNC_TO_CHIP5 interface
     uses data
      - value is the word to be send, if the width is configured to >32 the MS bits are ignored
    """

Definition at line 191 of file header.py.

◆ IN_ASYNC_TO_CHIP6

int IN_ASYNC_TO_CHIP6

static

Initial value:

=  36, """
     sends an 0-32bit word on the ASYNC_TO_CHIP6 interface
     uses data
      - value is the word to be send, if the width is configured to >32 the MS bits are ignored
    """

Definition at line 197 of file header.py.

◆ IN_ASYNC_TO_CHIP7

int IN_ASYNC_TO_CHIP7

static

Initial value:

=  37, """
     sends an 0-32bit word on the ASYNC_TO_CHIP7 interface
     uses data
      - value is the word to be send, if the width is configured to >32 the MS bits are ignored
    """

Definition at line 203 of file header.py.

◆ IN_CONF_READ_ON_REQUEST

int IN_CONF_READ_ON_REQUEST

static

Initial value:

=  6, """
     legacy mode: turn off automatic sending of the output buffer
     uses config
     - value 1 for read on request (legacy)
     - value 0 for continous read (default)
         @todo move to sub config
    """

Definition at line 98 of file header.py.

◆ IN_FREE_INSTRUCTION_SPOTS

int IN_FREE_INSTRUCTION_SPOTS

static

Initial value:

=  5, """
     this packet is used to request how many free spots there are in the instruction ring buffer
    """

Definition at line 90 of file header.py.

◆ IN_MAPPER_END

int IN_MAPPER_END

static

Initial value:

=  191, """
    In mapper end switches back to normal packet exec mode.
    """

Definition at line 272 of file header.py.

◆ IN_MAPPER_KEY

int IN_MAPPER_KEY

static

Initial value:

=  190, """
    in mapper key switches into sequence transmission mode,
    the next packet is considered the key all subsequent packages 
    are considdered values until IN_MAPPER_END.
    """

Definition at line 266 of file header.py.

◆ IN_READ

int IN_READ

static

Initial value:

=  0, """
    read all availiable output packets out of the output buffer, and clear the buffer afterwards
    uses data:
     - value is ignored
    """

Definition at line 61 of file header.py.

◆ IN_READ_INSTRUCTIONS

int IN_READ_INSTRUCTIONS

static

Initial value:

=  3, """
     read all availiable input packets out of the input buffer that have not been processed
     uses data
      - value is ignored
    """

Definition at line 78 of file header.py.

◆ IN_READ_LAST

int IN_READ_LAST

static

Initial value:

=  4, """
    read only the last package, does not remove this package from the ring buffer
    - value is ignored
    """

Definition at line 67 of file header.py.

◆ IN_READ_TIME

int IN_READ_TIME

static

Initial value:

=  2,  """
     return the current execution time to the output buffer
     uses data
      - value is ignored
    """

Definition at line 72 of file header.py.

◆ IN_RESET

int IN_RESET

static

Initial value:

=  254, """
     this packet is used to software reset the uC (clear the config), no harware reset is performed
    """

Definition at line 57 of file header.py.

◆ IN_SET_TIME

int IN_SET_TIME

static

Initial value:

=  1, """
     set the execution time, if set to 0 recording and exec are halted
     if set to 1 (or bigger) exec and recoding will be started from timestep 1 (or bigger)
     uses data
      - value is the time current to be set, maximum experiment time is 2^32 usec
    """

Definition at line 106 of file header.py.

◆ IN_SPI0

int IN_SPI0

static

Initial value:

=  20, """
     sends an 32bit word on the SPI0 interface
     uses data32
     - value is the 32bit to be send
    """

Definition at line 121 of file header.py.

◆ IN_SPI1

int IN_SPI1

static

Initial value:

=  21, """
     sends an 32bit word on the SPI1 interface
     uses data32
     - value is the 32bit to be send
    """

Definition at line 128 of file header.py.

◆ IN_SPI2

int IN_SPI2

static

Initial value:

=  22, """
     sends an 32bit word on the SPI2 interface
     uses data32
     - value is the 32bit to be send
    """

Definition at line 134 of file header.py.

◆ OUT_ASYNC_FROM_CHIP0

int OUT_ASYNC_FROM_CHIP0

static

Initial value:

=  130, """
     a event was reseved on ASYNC_FROM_CHIP0
     uses data
      - exec_time the current run time 
      - value the 0-32bit word that was read on the AER
    """

Definition at line 210 of file header.py.

◆ OUT_ASYNC_FROM_CHIP1

int OUT_ASYNC_FROM_CHIP1

static

Initial value:

=  131, """
     a event was reseved on ASYNC_FROM_CHIP1
     uses data
      - exec_time the current run time 
      - value the 0-32bit word that was read on the AER
    """

Definition at line 217 of file header.py.

◆ OUT_ASYNC_FROM_CHIP2

int OUT_ASYNC_FROM_CHIP2

static

Initial value:

=  132, """
     a event was reseved on ASYNC_FROM_CHIP2
     uses data
      - exec_time the current run time 
      - value the 0-32bit word that was read on the AER
    """

Definition at line 224 of file header.py.

◆ OUT_ASYNC_FROM_CHIP3

int OUT_ASYNC_FROM_CHIP3

static

Initial value:

=  133, """
     a event was reseved on ASYNC_FROM_CHIP3
     uses data
      - exec_time the current run time 
      - value the 0-32bit word that was read on the AER
    """

Definition at line 231 of file header.py.

◆ OUT_ASYNC_FROM_CHIP4

int OUT_ASYNC_FROM_CHIP4

static

Initial value:

=  134, """
     a event was reseved on ASYNC_FROM_CHIP4
     uses data
      - exec_time the current run time 
      - value the 0-32bit word that was read on the AER
    """

Definition at line 238 of file header.py.

◆ OUT_ASYNC_FROM_CHIP5

int OUT_ASYNC_FROM_CHIP5

static

Initial value:

=  135, """
     a event was reseved on ASYNC_FROM_CHIP5
     uses data
      - exec_time the current run time 
      - value the 0-32bit word that was read on the AER
    """

Definition at line 245 of file header.py.

◆ OUT_ASYNC_FROM_CHIP6

int OUT_ASYNC_FROM_CHIP6

static

Initial value:

=  136, """
     a event was reseved on ASYNC_FROM_CHIP6
     uses data
      - exec_time the current run time 
      - value the 0-32bit word that was read on the AER
    """

Definition at line 252 of file header.py.

◆ OUT_ASYNC_FROM_CHIP7

int OUT_ASYNC_FROM_CHIP7

static

Initial value:

=  137, """
     a event was reseved on ASYNC_FROM_CHIP7
     uses data
      - exec_time the current run time 
      - value the 0-32bit word that was read on the AER
    """

Definition at line 259 of file header.py.

◆ OUT_BUFFER_LAST_READ

int OUT_BUFFER_LAST_READ

static

Initial value:

=  250, """
     this packet is used to destinguish between an empty and a full buffer
     uses data
      - value is 1 so ignore
    """

Definition at line 84 of file header.py.

◆ OUT_FREE_INSTRUCTION_SPOTS

int OUT_FREE_INSTRUCTION_SPOTS

static

Initial value:

=  101, """
     this packet is used to report how many free spots there are in the instruction ring buffer
    """

Definition at line 94 of file header.py.

◆ OUT_SPI0

int OUT_SPI0

static

Initial value:

=  120, """
     responce to the IN_SPI0_32 packet
     uses data32
      - exec_time the current run time 
      - value the 32bit word that was read on the SPI
    """

Definition at line 140 of file header.py.

◆ OUT_SPI1

int OUT_SPI1

static

Initial value:

=  121, """
     responce to the IN_SPI1_32 packet
     uses data32
      - exec_time the current run time 
      - value the 32bit word that was read on the SPI
    """

Definition at line 147 of file header.py.

◆ OUT_SPI2

int OUT_SPI2

static

Initial value:

=  122, """
     responce to the IN_SPI2_32 packet
     uses data32
      - exec_time the current run time 
      - value the 32bit word that was read on the SPI
    """

Definition at line 154 of file header.py.

◆ OUT_TIME

int OUT_TIME

static

Initial value:

=  100, """
     responce to the READ_TIME packet
     uses data
      - exec_time the current run time 
      - value the system_time (without run time offset)
    """

Definition at line 113 of file header.py.

◆ UC_CLOSE_CONNECTION

int UC_CLOSE_CONNECTION

static

Initial value:

=  255, """
    this packet tells the PC buffer to close the connection to the uC
    """

Definition at line 53 of file header.py.

The documentation for this class was generated from the following file:

/github/workspace/uC_api/header.py

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ __new__()

Member Data Documentation

◆ IN_ASYNC_TO_CHIP0

◆ IN_ASYNC_TO_CHIP1

◆ IN_ASYNC_TO_CHIP2

◆ IN_ASYNC_TO_CHIP3

◆ IN_ASYNC_TO_CHIP4

◆ IN_ASYNC_TO_CHIP5

◆ IN_ASYNC_TO_CHIP6

◆ IN_ASYNC_TO_CHIP7

◆ IN_CONF_READ_ON_REQUEST

◆ IN_FREE_INSTRUCTION_SPOTS

◆ IN_MAPPER_END

◆ IN_MAPPER_KEY

◆ IN_READ

◆ IN_READ_INSTRUCTIONS

◆ IN_READ_LAST

◆ IN_READ_TIME

◆ IN_RESET

◆ IN_SET_TIME

◆ IN_SPI0

◆ IN_SPI1

◆ IN_SPI2

◆ OUT_ASYNC_FROM_CHIP0

◆ OUT_ASYNC_FROM_CHIP1

◆ OUT_ASYNC_FROM_CHIP2

◆ OUT_ASYNC_FROM_CHIP3

◆ OUT_ASYNC_FROM_CHIP4

◆ OUT_ASYNC_FROM_CHIP5

◆ OUT_ASYNC_FROM_CHIP6

◆ OUT_ASYNC_FROM_CHIP7

◆ OUT_BUFFER_LAST_READ

◆ OUT_FREE_INSTRUCTION_SPOTS

◆ OUT_SPI0

◆ OUT_SPI1

◆ OUT_SPI2

◆ OUT_TIME

◆ UC_CLOSE_CONNECTION

◆ new()