Source code for spinnman.messages.scp.impl.iptag_set

# Copyright (c) 2017-2019 The University of Manchester
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <>.

from spinn_utilities.overrides import overrides
from spinnman.messages.scp import SCPRequestHeader
from spinnman.messages.scp.abstract_messages import AbstractSCPRequest
from spinnman.messages.scp.enums import SCPCommand
from spinnman.messages.sdp import SDPFlag, SDPHeader
from .check_ok_response import CheckOKResponse


[docs]class IPTagSet(AbstractSCPRequest): """ An SCP Request to set an IP Tag """ __slots__ = [] def __init__(self, x, y, host, port, tag, strip, use_sender=False): """ :param int x: The x-coordinate of a chip, between 0 and 255 :param int y: The y-coordinate of a chip, between 0 and 255 :param bytearray or list[int] host: The host address, \ as an array of 4 bytes :param int port: The port, between 0 and 65535 :param int tag: The tag, between 0 and 7 :param bool strip: if the SDP header should be striped from the packet :param bool use_sender: if the sender IP address and port should be used """ # pylint: disable=too-many-arguments strip_value = int(bool(strip)) sender_value = int(bool(use_sender)) super().__init__( SDPHeader( flags=SDPFlag.REPLY_EXPECTED, destination_port=0, destination_cpu=0, destination_chip_x=x, destination_chip_y=y), SCPRequestHeader(command=SCPCommand.CMD_IPTAG), argument_1=(strip_value << 28) | (sender_value << 30) | (_IPTAG_SET << 16) | tag, argument_2=port, argument_3=((host[3] << 24) | (host[2] << 16) | (host[1] << 8) | host[0]))
[docs] @overrides(AbstractSCPRequest.get_scp_response) def get_scp_response(self): return CheckOKResponse("Set IP Tag", "CMD_IPTAG")