rp2da2.rp2dcc.dcc_cmd_util.FGrp1Command

class documentation

class FGrp1Command(CommandPacket):

Constructor: FGrp1Command(address, f_num, state)

Function Group 1 Packet

Function group 1 commands are built for specific DCC addresses and are retained on the packet list for periodic transmission. The function number and state may be updated.

Method	`__init__`	Construct a Function Group 1 Command
Method	`update`	Update Function Group 1 command
Constant	`TYPE`	F - Function Group 1 Command
Instance Variable	`_address`	Undocumented
Instance Variable	`_byte_list`	Undocumented
Instance Variable	`_type`	Undocumented

Inherited from CommandPacket:

Method	`is_locked`	Is Locked
Method	`set_buffer`	Set buffer contents
Constant	`BASE_LONG_ADDR`	DCC long mobile address range base
Constant	`MAX_LONG_ADDR`	DCC long address upper limit (inclusive)
Constant	`MIN_LONG_ADDR`	DCC long address lower limit (inclusive)
Instance Variable	`NOT_SENT`	Return value for command not sent (command being updated)
Instance Variable	`SENT`	Return value for command serialised
Instance Variable	`SENT_POM`	Return valued for Program on Main second send
Property	`address`	Get Address
Property	`packet_buffer`	Get the Packet Buffer
Property	`type`	Get the command type
Instance Variable	`_packet_buff`	Undocumented

def __init__(self, address, f_num, state): ¶

overrides rp2da2.rp2dcc.dcc_cmd_util.CommandPacket.__init__

Construct a Function Group 1 Command

This constructs a function group one command. It calls __init__ in the base class. It sets the type, address, function number and function state. Function numbers and associated states may be updated later.

Note

Parameters not validated here.

Parameters
address	DCC address of target decoder
f_num	The group 1 function number to be set or unset
state	may be set or unset (1 or 0)

def update(self, f_num, state): ¶

Update Function Group 1 command

Allows a function number in group 1 to be set or unset.

Parameters
f_num	The group 1 function number to be set or unset
state	may be set or unset (1 or 0)

TYPE: str = ¶

F - Function Group 1 Command

Value

'F'

_address = ¶

Undocumented

_byte_list = ¶

Undocumented

_type = ¶

Undocumented