Skip to content

Multicast group

Multicast group resource for Class B/C multicast group management.

SyncMulticastGroups 

SyncMulticastGroups(client: SyncClient)

Bases: BaseResource['SyncClient']

Multicast groups resource for multicast group management.

Methods:

  • add_gateways –

    Add gateways to a multicast group.

  • create –

    Create a new multicast group.

  • delete –

    Delete a multicast group.

  • get –

    Retrieve a multicast group by its MulticastDevEUI.

  • get_all –

    List all multicast groups.

  • get_all_gateways –

    List gateways associated with a multicast group.

  • remove_gateways –

    Remove gateways from a multicast group.

  • update –

    Update a multicast group.

add_gateways 

add_gateways(
    multicast_deveui: str, node_ids: list[str]
) -> AddGatewaysWithMulticastGroupResponse

Add gateways to a multicast group.

Parameters:

  • multicast_deveui

    (str) –

    The unique multicast device EUI.

  • node_ids

    (list[str]) –

    The list of node ids to add to the multicast group.

Returns:

create 

create(data: CreateMulticastGroupRequest) -> bool

Create a new multicast group.

Parameters:

Returns:

  • bool ( bool ) –

    True if the creation was successful, False otherwise.

delete 

delete(multicast_deveui: str) -> bool

Delete a multicast group.

Parameters:

  • multicast_deveui

    (str) –

    The unique multicast device EUI to delete.

Returns:

  • bool ( bool ) –

    True if the deletion was successful, False otherwise.

get 

get(multicast_deveui: str) -> MulticastGroup

Retrieve a multicast group by its MulticastDevEUI.

Parameters:

  • multicast_deveui

    (str) –

    The unique multicast device EUI.

Returns:

  • MulticastGroup ( MulticastGroup ) –

    The multicast group instance matching the given DevEUI.

get_all 

get_all() -> list[MulticastGroup]

List all multicast groups.

Returns:

get_all_gateways 

get_all_gateways(multicast_deveui: str) -> list[str]

List gateways associated with a multicast group.

Parameters:

  • multicast_deveui

    (str) –

    The unique multicast device EUI.

Returns:

  • list[str] –

    list[str]: NodeIDs in the multicast group.

remove_gateways 

remove_gateways(
    multicast_deveui: str, node_ids: list[str]
) -> RemoveGatewaysFromMulticastGroupResponse

Remove gateways from a multicast group.

Parameters:

  • multicast_deveui

    (str) –

    The unique multicast device EUI.

  • node_ids

    (list[str]) –

    The list of node ids to remove from the multicast group.

Returns:

update 

update(
    multicast_deveui: str, data: UpdateMulticastGroupRequest
) -> bool

Update a multicast group.

Parameters:

Returns:

  • bool ( bool ) –

    True if the update was successful, False otherwise.

AsyncMulticastGroups 

AsyncMulticastGroups(client: AsyncClient)

Bases: BaseResource['AsyncClient']

Async multicast groups resource for multicast group management.

Methods:

  • add_gateways –

    Add gateways to a multicast group.

  • create –

    Create a new multicast group.

  • delete –

    Delete a multicast group.

  • get –

    Retrieve a multicast group by its MulticastDevEUI.

  • get_all –

    List all multicast groups.

  • get_all_gateways –

    List gateways associated with a multicast group.

  • remove_gateways –

    Remove gateways from a multicast group.

  • update –

    Update a multicast group.

add_gateways async 

add_gateways(
    multicast_deveui: str, node_ids: list[str]
) -> AddGatewaysWithMulticastGroupResponse

Add gateways to a multicast group.

Parameters:

  • multicast_deveui

    (str) –

    The unique multicast device EUI.

  • node_ids

    (list[str]) –

    The list of node ids to add to the multicast group.

Returns:

create async 

create(data: CreateMulticastGroupRequest) -> bool

Create a new multicast group.

Parameters:

Returns:

  • bool ( bool ) –

    True if the creation was successful, False otherwise.

delete async 

delete(multicast_deveui: str) -> bool

Delete a multicast group.

Parameters:

  • multicast_deveui

    (str) –

    The unique multicast device EUI to delete.

Returns:

  • bool ( bool ) –

    True if the deletion was successful, False otherwise.

get async 

get(multicast_deveui: str) -> MulticastGroup

Retrieve a multicast group by its MulticastDevEUI.

Parameters:

  • multicast_deveui

    (str) –

    The unique multicast device EUI.

Returns:

  • MulticastGroup ( MulticastGroup ) –

    The multicast group instance matching the given DevEUI.

get_all async 

get_all() -> list[MulticastGroup]

List all multicast groups.

Returns:

get_all_gateways async 

get_all_gateways(multicast_deveui: str) -> list[str]

List gateways associated with a multicast group.

Parameters:

  • multicast_deveui

    (str) –

    The unique multicast device EUI.

Returns:

  • list[str] –

    list[str]: NodeIDs in the multicast group.

remove_gateways async 

remove_gateways(
    multicast_deveui: str, node_ids: list[str]
) -> RemoveGatewaysFromMulticastGroupResponse

Remove gateways from a multicast group.

Parameters:

  • multicast_deveui

    (str) –

    The unique multicast device EUI.

  • node_ids

    (list[str]) –

    The list of node ids to remove from the multicast group.

Returns:

update async 

update(
    multicast_deveui: str, data: UpdateMulticastGroupRequest
) -> bool

Update a multicast group.

Parameters:

Returns:

  • bool ( bool ) –

    True if the update was successful, False otherwise.

Request and response types: Multicast group models.