Skip to content

Multicast group models

Request and response types for the Multicast group API.

models

Classes:

AddGatewaysWithMulticastGroupRequest

Bases: BaseModelWithConfig

Attributes:

gateways instance-attribute

gateways: list[str]

AddGatewaysWithMulticastGroupResponse

Bases: BaseModelWithConfig

Attributes:

gateways_added instance-attribute

gateways_added: list[str]

gateways_ignored instance-attribute

gateways_ignored: list[str]

CreateMulticastGroupRequest

Bases: BaseModelWithConfig

Attributes:

data_rate instance-attribute

data_rate: int

frequency instance-attribute

frequency: int

The frequency for multicast group in units of Hz.

group_type instance-attribute

group_type: MulticastGroupType

multicast_app_s_key instance-attribute

multicast_app_s_key: str

multicast_dev_addr instance-attribute

multicast_dev_addr: str

multicast_deveui instance-attribute

multicast_deveui: str

multicast_nwk_s_key instance-attribute

multicast_nwk_s_key: str

name instance-attribute

name: str

ping_slot_period class-attribute instance-attribute

ping_slot_period: int = 0

The pingslot period for multicast group. Required for ClassB, ignored for ClassC.

GetGatewaysByMulticastGroupResponse

Bases: BaseModelWithConfig

Attributes:

gateways instance-attribute

gateways: list[str]

GetMulticastGroupResponse

Bases: BaseModelWithConfig

Attributes:

multicast_group instance-attribute

multicast_group: MulticastGroup

GetMulticastGroupsResponse

Bases: BaseModelWithConfig

Attributes:

multicast_groups instance-attribute

multicast_groups: list[MulticastGroup]

MulticastGroup

Bases: BaseModelWithConfig

Attributes:

data_rate instance-attribute

data_rate: int

frequency instance-attribute

frequency: int

group_type instance-attribute

group_type: str

multicast_dev_addr instance-attribute

multicast_dev_addr: str

multicast_deveui instance-attribute

multicast_deveui: str

name instance-attribute

name: str

ping_slot_period instance-attribute

ping_slot_period: int

MulticastGroupType

Bases: str, Enum

Attributes:

CLASS_B class-attribute instance-attribute

CLASS_B = 'B'

CLASS_C class-attribute instance-attribute

CLASS_C = 'C'

RemoveGatewaysFromMulticastGroupRequest

Bases: BaseModelWithConfig

Attributes:

gateways instance-attribute

gateways: list[str]

RemoveGatewaysFromMulticastGroupResponse

Bases: BaseModelWithConfig

Attributes:

gateways_ignored instance-attribute

gateways_ignored: list[str]

gateways_removed instance-attribute

gateways_removed: list[str]

UpdateMulticastGroupRequest

Bases: BaseModelWithConfig

Attributes:

data_rate instance-attribute

data_rate: int

frequency instance-attribute

frequency: int

name instance-attribute

name: str