Group Function

class n2k.group_function.N2kGroupFunctionCode(*values)[source]

Bases: IntEnum

Request = 0

Command = 1

Acknowledge = 2

Read = 3

ReadReply = 4

Write = 5

WriteReply = 6

class n2k.group_function.N2kGroupFunctionPGNErrorCode(*values)[source]

Bases: IntEnum

Acknowledge = 0

PGNNotSupported = 1

PGNTemporarilyNotAvailable = 2

AccessDenied = 3

RequestOrCommandNotSupported = 4

DefinerTagNotSupported = 5

ReadOrWriteNotSupported = 6

class n2k.group_function.N2kGroupFunctionTransmissionOrPriorityErrorCode(*values)[source]

Bases: IntEnum

Acknowledge = 0

TransmitIntervalOrPriorityNotSupported = 1

TransmitIntervalIsLessThanMeasurementInterval = 2

AccessDenied = 3

RequestNotSupported = 4

class n2k.group_function.N2kGroupFunctionParameterErrorCode(*values)[source]

Bases: IntEnum

Acknowledge = 0

InvalidRequestOrCommandParameterField = 1

TemporarilyUnableToComply = 2

RequestOrCommandParameterOutOfRange = 3

AccessDenied = 4

RequestOrCommandNotSupported = 5

ReadOrWriteIsNotSupported = 6

n2k.group_function.match_request_field(field_val: int, match_val: int, mask: int) → tuple[bool, int][source]

Return type:: tuple[bool, int]

n2k.group_function.match_request_field_str(field_val: str, match_val: str) → tuple[bool, int][source]

Return type:: tuple[bool, int]

class n2k.group_function.N2kGroupFunctionHandler(n2k_node: Node, pgn: int) → None[source]

Bases: object

proprietary: bool

_get_request_group_function_transmission_or_priority_error_code(transmission_interval: int) → N2kGroupFunctionTransmissionOrPriorityErrorCode[source]

Return type:: N2kGroupFunctionTransmissionOrPriorityErrorCode

_handle_request(msg: Message, transmission_interval: int, transmission_interval_offset: int, number_of_parameter_pairs: int) → bool[source]

Return type:: bool

_handle_command(msg: Message, priority_setting: int, number_of_parameter_pairs: int) → bool[source]

Return type:: bool

_handle_acknowledge(msg: Message, pgn_error_code: N2kGroupFunctionPGNErrorCode, transmission_or_priority_error_code: N2kGroupFunctionTransmissionOrPriorityErrorCode, number_of_parameter_pairs: int) → bool[source]

Return type:: bool

_handle_read_fields(msg: Message, manufacturer_code: int, industry_group: int, unique_id: int, number_of_selection_pairs: int, number_of_parameter_pairs: int) → bool[source]

Return type:: bool

_handle_read_fields_reply(msg: Message) → bool[source]

Return type:: bool

_handle_write_fields(msg: Message, manufacturer_code: int, industry_group: int, unique_id: int, number_of_selection_pairs: int, number_of_parameter_pairs: int) → bool[source]

Return type:: bool

_handle_write_fields_reply(msg: Message) → bool[source]

Return type:: bool

__init__(n2k_node: Node, pgn: int) → None[source]

n2k_node: Node

_pgn: int

handle(msg: Message, group_function_code: N2kGroupFunctionCode, pgn_for_group_function: int) → bool[source]

Return type:: bool

n2k.group_function.get_pgn_for_group_function(msg: Message) → int[source]

Return type:: int

n2k.group_function.parse(msg: Message, group_function_code: N2kGroupFunctionCode, pgn_for_group_function: PGN) → bool[source]

Return type:: bool

n2k.group_function.parse_request_params(msg: Message, transmission_interval: int, transmission_interval_offset: int, number_of_parameter_pairs: int) → bool[source]

Return type:: bool

n2k.group_function.start_parse_request_pair_parameters(msg: Message, index: int) → bool[source]

Return type:: bool

n2k.group_function.parse_command_params(msg: Message, priority_setting: int, number_of_parameter_pairs: int) → bool[source]

Return type:: bool

n2k.group_function.start_parse_command_pair_parameters(msg: Message, index: int) → bool[source]

Return type:: bool

n2k.group_function.parse_acknowledge_params(msg: Message, pgn_error_code: N2kGroupFunctionPGNErrorCode, transmission_or_priority_error_code: N2kGroupFunctionTransmissionOrPriorityErrorCode, number_of_parameter_pairs: int) → bool[source]

Return type:: bool

n2k.group_function.start_parse_read_or_write_parameters(msg: Message, index: int) → bool[source]

Return type:: bool

n2k.group_function.parse_read_or_write_params(msg: Message, manufacturer_code: int, industry_group: int, unique_id: int, number_of_selection_pairs: int, number_of_parameter_pairs: int, proprietary: bool = False) → bool[source]

Return type:: bool

n2k.group_function.set_start_read_reply(msg: Message, destination: int, pgn: int, manufacturer_code: int, industry_group: int, unique_id: int, number_of_selection_pairs: int, number_of_parameter_pairs: int, proprietary: bool) → None[source]

Return type:: None

n2k.group_function.set_start_write_reply(msg: Message, destination: int, pgn: int, manufacturer_code: int, industry_group: int, unique_id: int, number_of_selection_pairs: int, number_of_parameter_pairs: int, proprietary: bool) → None[source]

Return type:: None

n2k.group_function.set_start_acknowledge(msg: Message, destination: int, pgn: int, pgn_error_code: N2kGroupFunctionPGNErrorCode, transmission_or_priority_error_code: N2kGroupFunctionTransmissionOrPriorityErrorCode, number_of_parameter_pairs: int = 0) → None[source]

Return type:: None

n2k.group_function.change_pgn_error_code(msg: Message, pgn_error_code: N2kGroupFunctionPGNErrorCode) → None[source]

Return type:: None

n2k.group_function.change_transmission_or_priority_error_code(msg: Message, transmission_or_priority_error_code: N2kGroupFunctionTransmissionOrPriorityErrorCode) → None[source]

Return type:: None

n2k.group_function.add_acknowledge_parameter(msg: Message, parameter_pair_index: int, error_code: N2kGroupFunctionParameterErrorCode = N2kGroupFunctionParameterErrorCode.ReadOrWriteIsNotSupported) → None[source]

Return type:: None

n2k.group_function.send_acknowledge(node: Node, destination: int, pgn: int, pgn_error_code: N2kGroupFunctionPGNErrorCode, transmission_or_priority_error_code: N2kGroupFunctionTransmissionOrPriorityErrorCode, number_of_parameter_pairs: int = 0, parameter_error_code_for_all: N2kGroupFunctionParameterErrorCode = N2kGroupFunctionParameterErrorCode.Acknowledge) → None[source]

Return type:: None