spinn_machine.tags package

Module contents

class spinn_machine.tags.AbstractTag(board_address: str, tag: int, port: int)

Bases: object

Common properties of SpiNNaker IP tags and reverse IP tags.

property board_address: str

The board address of the tag.

property port: int

The port of the tag.

property tag: int

The tag ID of the tag.

class spinn_machine.tags.IPTag(board_address: str, destination_x: int, destination_y: int, tag: int, ip_address: str, port: int, strip_sdp: bool = False, traffic_identifier: str = 'DEFAULT')

Bases: AbstractTag

Used to hold data that is contained within an IP tag.

Parameters:

  • board_address – The IP address of the board on which the tag is allocated

  • destination_x – The x-coordinate where users of this tag should send packets to

  • destination_y – The y-coordinate where users of this tag should send packets to

  • tag – The tag of the SDP packet

  • ip_address (str) – The IP address to which SDP packets with the tag will be sent

  • port – The port to which the SDP packets with the tag will be sent, or

  • strip_sdp (bool) – Indicates whether the SDP header should be removed

  • traffic_identifier (str) – The identifier for traffic transmitted using this tag

property destination_x: int

The X-coordinate where users of this tag should send packets to.

property destination_y: int

The Y-coordinate where users of this tag should send packets to.

property ip_address: str

The IP address to which SDP packets with this tag will be sent.

property strip_sdp: bool

Whether the SDP header is to be stripped.

property traffic_identifier: str

The identifier of traffic using this tag.

class spinn_machine.tags.ReverseIPTag(board_address: str, tag: int, port: int, destination_x: int, destination_y: int, destination_p: int, sdp_port: int = 1)

Bases: AbstractTag

Used to hold data that is contained within a Reverse IP tag.

Parameters:

  • board_address (str or None) – The IP address of the board on which the tag is allocated

  • tag (int) – The tag of the SDP packet

  • port (int) – The UDP port on which SpiNNaker will listen for packets

  • destination_x (int) – The x-coordinate of the chip to send packets to

  • destination_y (int) – The y-coordinate of the chip to send packets to

  • destination_p (int) – The ID of the processor to send packets to

  • sdp_port (int) – The optional port number to use for SDP packets that are formed on the machine (default is 1)

property destination_p: int

The destination processor ID for the chip at (x,y) that packets should be send to for this reverse IP tag.

property destination_x: int

The destination x coordinate of a chip in the SpiNNaker machine that packets should be sent to for this reverse IP tag.

property destination_y: int

The destination y coordinate of a chip in the SpiNNaker machine that packets should be sent to for this reverse IP tag.

property sdp_port: int

The SDP port number of the tag that these packets are to be received on for the processor.