The Thing Bluetooth mesh device groups allow you to create and update groups and add devices to the groups. More...

#import <ThingSmartBleMeshGroup.h>

Inheritance diagram for ThingSmartBleMeshGroup:

Instance Methods
(instancetype)	- initWithGroupId:

(instancetype)	- NS_UNAVAILABLE

(void)	- deleteBleMeshGroupAddress:

(void)	- updateMeshGroupName:success:failure:

(void)	- removeMeshGroupWithSuccess:failure:

(void)	- addDeviceWithDeviceId:success:failure:

(void)	- editDeviceWithDeviceList:success:failure:

(void)	- removeDeviceWithDeviceId:success:failure:

(void)	- getDeviceListInfoWithSuccess:failure:

(void)	- getDeviveListInfoWithSuccess:failure:

(instancetype)	- initWithGroupId:

(instancetype)	- NS_UNAVAILABLE

(void)	- deleteBleMeshGroupAddress:

(void)	- updateMeshGroupName:success:failure:

(void)	- removeMeshGroupWithSuccess:failure:

(void)	- addDeviceWithDeviceId:success:failure:

(void)	- editDeviceWithDeviceList:success:failure:

(void)	- removeDeviceWithDeviceId:success:failure:

(void)	- getDeviceListInfoWithSuccess:failure:

(void)	- getDeviveListInfoWithSuccess:failure:

(void)	- addSubDeviceWithSubList:success:failure:

(void)	- addSubDeviceWithSubList:success:failure:

(void)	- addSubDeviceWithSubList:localId:mainDevId:categoryCode:success:failure:

(void)	- addSubDeviceWithSubList:localId:mainDevId:categoryCode:success:failure:

(void)	- removeSubDeviceWithSubList:success:failure:

(void)	- removeSubDeviceWithSubList:success:failure:

(void)	- removeSubDeviceWithSubList:localId:mainDevId:categoryCode:success:failure:

(void)	- removeSubDeviceWithSubList:localId:mainDevId:categoryCode:success:failure:

(void)	- publishDps:success:failure:

(void)	- publishDps:success:failure:

(void)	- publishDpsWithParams:success:failure:

(void)	- publishDpsWithParams:success:failure:

Class Methods
(instancetype)	+ meshGroupWithGroupId:

(void)	+ getBleMeshGroupAddressFromCluondWithMeshId:success:failure:

(void)	+ createMeshGroupWithGroupName:meshId:localId:pcc:success:failure:

(NSInteger)	+ getBleMeshGroupAddress

(NSInteger)	+ getBleMeshGroupCount

(instancetype)	+ meshGroupWithGroupId:

(void)	+ getBleMeshGroupAddressFromCluondWithMeshId:success:failure:

(void)	+ createMeshGroupWithGroupName:meshId:localId:pcc:success:failure:

(NSInteger)	+ getBleMeshGroupAddress

(NSInteger)	+ getBleMeshGroupCount

Properties
id< ThingSmartBleMeshGroupDelegate >	delegate

ThingSmartGroupModel *	meshGroupModel

Detailed Description

The Thing Bluetooth mesh device groups allow you to create and update groups and add devices to the groups.

You can create a group of mesh devices with the same functions and simultaneously control them with a single command.

Definition at line 32 of file ThingSmartBleMeshGroup.h.

Method Documentation

◆ addDeviceWithDeviceId:success:failure: [1/2]

- (void) addDeviceWithDeviceId:	(NSString *)	deviceId
success:	(ThingSuccessHandler)	success
failure:	(ThingFailureError)	failure

Adds a device.

Parameters

deviceId	The device ID.
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

◆ addDeviceWithDeviceId:success:failure: [2/2]

- (void) addDeviceWithDeviceId:	(NSString *)	deviceId
success:	(ThingSuccessHandler)	success
failure:	(ThingFailureError)	failure

Adds a device.

Parameters

deviceId	The device ID.
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

◆ addSubDeviceWithSubList:localId:mainDevId:categoryCode:success:failure: [1/2]

- (void) addSubDeviceWithSubList:	(NSArray< ThingSmartDeviceModel * > *_Nonnull)	subList
localId:	(NSString *)	localId
mainDevId:	(nullable NSString *)	devId
categoryCode:	(nullable NSString *)	categoryCode
success:	(nullable ThingSuccessHandler)	success
failure:	(nullable ThingFailureError)	failure

Adds a Bluetooth mesh sub-device group through the Bluetooth mesh gateway. The sub-devices must belong to the Bluetooth mesh gateway.

Parameters

subList	The gateway sub-device to be managed.
localId	mesh groupId
devId	remote control's devId
categoryCode	remote control's categoryCode
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

Provided by category ThingSmartBleMeshGroup(SIGMesh).

◆ addSubDeviceWithSubList:localId:mainDevId:categoryCode:success:failure: [2/2]

- (void) addSubDeviceWithSubList:	(NSArray< ThingSmartDeviceModel * > *_Nonnull)	subList
localId:	(NSString *)	localId
mainDevId:	(nullable NSString *)	devId
categoryCode:	(nullable NSString *)	categoryCode
success:	(nullable ThingSuccessHandler)	success
failure:	(nullable ThingFailureError)	failure

Adds a Bluetooth mesh sub-device group through the Bluetooth mesh gateway. The sub-devices must belong to the Bluetooth mesh gateway.

Parameters

subList	The gateway sub-device to be managed.
localId	mesh groupId
devId	remote control's devId
categoryCode	remote control's categoryCode
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

Provided by category ThingSmartBleMeshGroup(SIGMesh).

◆ addSubDeviceWithSubList:success:failure: [1/2]

- (void) addSubDeviceWithSubList:	(NSArray< ThingSmartDeviceModel * > *_Nonnull)	subList
success:	(nullable ThingSuccessHandler)	success
failure:	(nullable ThingFailureError)	failure

Adds a Bluetooth mesh sub-device group through the Bluetooth mesh gateway. The sub-devices must belong to the Bluetooth mesh gateway.

Parameters

subList	The gateway sub-device to be managed.
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

Provided by category ThingSmartBleMeshGroup(SIGMesh).

◆ addSubDeviceWithSubList:success:failure: [2/2]

- (void) addSubDeviceWithSubList:	(NSArray< ThingSmartDeviceModel * > *_Nonnull)	subList
success:	(nullable ThingSuccessHandler)	success
failure:	(nullable ThingFailureError)	failure

Adds a Bluetooth mesh sub-device group through the Bluetooth mesh gateway. The sub-devices must belong to the Bluetooth mesh gateway.

Parameters

subList	The gateway sub-device to be managed.
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

Provided by category ThingSmartBleMeshGroup(SIGMesh).

◆ createMeshGroupWithGroupName:meshId:localId:pcc:success:failure: [1/2]

+ (void) createMeshGroupWithGroupName:	(NSString *)	groupName
meshId:	(NSString *)	meshId
localId:	(NSString *)	localId
pcc:	(NSString *)	pcc
success:	(ThingSuccessInt)	success
failure:	(ThingFailureError)	failure

Creates a mesh group.

Parameters

groupName	The mesh group name.
meshId	The mesh ID.
localId	The local short address of the group.
pcc	The size class label of each group device.
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

◆ createMeshGroupWithGroupName:meshId:localId:pcc:success:failure: [2/2]

+ (void) createMeshGroupWithGroupName:	(NSString *)	groupName
meshId:	(NSString *)	meshId
localId:	(NSString *)	localId
pcc:	(NSString *)	pcc
success:	(ThingSuccessInt)	success
failure:	(ThingFailureError)	failure

Creates a mesh group.

Parameters

groupName	The mesh group name.
meshId	The mesh ID.
localId	The local short address of the group.
pcc	The size class label of each group device.
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

◆ deleteBleMeshGroupAddress: [1/2]

- (void) deleteBleMeshGroupAddress: (NSInteger) address

◆ deleteBleMeshGroupAddress: [2/2]

- (void) deleteBleMeshGroupAddress: (NSInteger) address

◆ editDeviceWithDeviceList:success:failure: [1/2]

- (void) editDeviceWithDeviceList:	(NSArray *)	deviceList
success:	(ThingSuccessHandler)	success
failure:	(ThingFailureError)	failure

Modifies multiple devices in a call.

Parameters

deviceList	The device list.
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

◆ editDeviceWithDeviceList:success:failure: [2/2]

- (void) editDeviceWithDeviceList:	(NSArray *)	deviceList
success:	(ThingSuccessHandler)	success
failure:	(ThingFailureError)	failure

Modifies multiple devices in a call.

Parameters

deviceList	The device list.
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

◆ getBleMeshGroupAddress [1/2]

+ (NSInteger) getBleMeshGroupAddress

◆ getBleMeshGroupAddress [2/2]

+ (NSInteger) getBleMeshGroupAddress

◆ getBleMeshGroupAddressFromCluondWithMeshId:success:failure: [1/2]

+ (void) getBleMeshGroupAddressFromCluondWithMeshId:	(NSString *)	meshId
success:	(ThingSuccessInt)	success
failure:	(ThingFailureError)	failure

Assigns a group ID from the cloud.

Parameters

meshId	The mesh ID.
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

◆ getBleMeshGroupAddressFromCluondWithMeshId:success:failure: [2/2]

+ (void) getBleMeshGroupAddressFromCluondWithMeshId:	(NSString *)	meshId
success:	(ThingSuccessInt)	success
failure:	(ThingFailureError)	failure

Assigns a group ID from the cloud.

Parameters

meshId	The mesh ID.
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

◆ getBleMeshGroupCount [1/2]

+ (NSInteger) getBleMeshGroupCount

◆ getBleMeshGroupCount [2/2]

+ (NSInteger) getBleMeshGroupCount

◆ getDeviceListInfoWithSuccess:failure: [1/2]

- (void) getDeviceListInfoWithSuccess:	(void(^)(NSArray< ThingSmartDeviceModel * > *deviceList))	success
failure:	(ThingFailureError)	failure

Returns a list of devices from the group.

Parameters

success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

◆ getDeviceListInfoWithSuccess:failure: [2/2]

- (void) getDeviceListInfoWithSuccess:	(void(^)(NSArray< ThingSmartDeviceModel * > *deviceList))	success
failure:	(ThingFailureError)	failure

Returns a list of devices from the group.

Parameters

success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

◆ getDeviveListInfoWithSuccess:failure: [1/2]

- (void) getDeviveListInfoWithSuccess:	(void(^)(NSArray< ThingSmartDeviceModel * > *deviceList))	success
failure:	("This method is)	deprecated
	(Use instead")	__deprecated_msg[ThingSmartBleMeshGroup getDeviceListInfoWithSuccess:failure:]

Returns a list of devices from the group.

Parameters

success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

Deprecated:: This method is deprecated, Use ThingSmartBleMeshGroup getDeviceListInfoWithSuccess:failure: instead.

◆ getDeviveListInfoWithSuccess:failure: [2/2]

- (void) getDeviveListInfoWithSuccess:	(void(^)(NSArray< ThingSmartDeviceModel * > *deviceList))	success
failure:	("This method is)	deprecated
	(Use instead")	__deprecated_msg[ThingSmartBleMeshGroup getDeviceListInfoWithSuccess:failure:]

Returns a list of devices from the group.

Parameters

success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

Deprecated:: This method is deprecated, Use ThingSmartBleMeshGroup getDeviceListInfoWithSuccess:failure: instead.

◆ initWithGroupId: [1/2]

- (instancetype) initWithGroupId: (NSInteger) NS_DESIGNATED_INITIALIZER

Returns the mesh group object.

Parameters

groupId The group ID.

◆ initWithGroupId: [2/2]

- (instancetype) initWithGroupId: (NSInteger) NS_DESIGNATED_INITIALIZER

Returns the mesh group object.

Parameters

groupId The group ID.

◆ meshGroupWithGroupId: [1/2]

+ (instancetype) meshGroupWithGroupId: (NSInteger) groupId

Returns the mesh group object.

Parameters

groupId The group ID.

◆ meshGroupWithGroupId: [2/2]

+ (instancetype) meshGroupWithGroupId: (NSInteger) groupId

Returns the mesh group object.

Parameters

groupId The group ID.

◆ NS_UNAVAILABLE [1/2]

- (instancetype) NS_UNAVAILABLE

◆ NS_UNAVAILABLE [2/2]

- (instancetype) NS_UNAVAILABLE

◆ publishDps:success:failure: [1/2]

- (void) publishDps:	(NSDictionary *)	dps
success:	(nullable ThingSuccessHandler)	success
failure:	(nullable ThingFailureError)	failure

Provided by category ThingSmartBleMeshGroup(SIGMesh).

◆ publishDps:success:failure: [2/2]

- (void) publishDps:	(NSDictionary *)	dps
success:	(nullable ThingSuccessHandler)	success
failure:	(nullable ThingFailureError)	failure

Provided by category ThingSmartBleMeshGroup(SIGMesh).

◆ publishDpsWithParams:success:failure: [1/2]

- (void) publishDpsWithParams:	(NSDictionary *)	params
success:	(ThingSuccessHandler)	success
failure:	(ThingFailureError)	failure

Publishes custom parameters.

Parameters

params	param:dictionary { "localId":"c050" ,"dps":{"1":true} "pcc":"1510"}
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

Provided by category ThingSmartBleMeshGroup(SIGMesh).

◆ publishDpsWithParams:success:failure: [2/2]

- (void) publishDpsWithParams:	(NSDictionary *)	params
success:	(ThingSuccessHandler)	success
failure:	(ThingFailureError)	failure

Publishes custom parameters.

Parameters

params	param:dictionary { "localId":"c050" ,"dps":{"1":true} "pcc":"1510"}
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

Provided by category ThingSmartBleMeshGroup(SIGMesh).

◆ removeDeviceWithDeviceId:success:failure: [1/2]

- (void) removeDeviceWithDeviceId:	(NSString *)	deviceId
success:	(ThingSuccessHandler)	success
failure:	(ThingFailureError)	failure

Removes the device.

Parameters

deviceId	The device ID.
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

◆ removeDeviceWithDeviceId:success:failure: [2/2]

- (void) removeDeviceWithDeviceId:	(NSString *)	deviceId
success:	(ThingSuccessHandler)	success
failure:	(ThingFailureError)	failure

Removes the device.

Parameters

deviceId	The device ID.
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

◆ removeMeshGroupWithSuccess:failure: [1/2]

- (void) removeMeshGroupWithSuccess:	(ThingSuccessHandler)	success
failure:	(ThingFailureError)	failure

Deletes the mesh group.

Parameters

success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

◆ removeMeshGroupWithSuccess:failure: [2/2]

- (void) removeMeshGroupWithSuccess:	(ThingSuccessHandler)	success
failure:	(ThingFailureError)	failure

Deletes the mesh group.

Parameters

success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

◆ removeSubDeviceWithSubList:localId:mainDevId:categoryCode:success:failure: [1/2]

- (void) removeSubDeviceWithSubList:	(NSArray< ThingSmartDeviceModel * > *_Nonnull)	subList
localId:	(NSString *)	localId
mainDevId:	(nullable NSString *)	devId
categoryCode:	(nullable NSString *)	categoryCode
success:	(nullable ThingSuccessHandler)	success
failure:	(nullable ThingFailureError)	failure

Deletes a Bluetooth mesh sub-device group through the Bluetooth mesh gateway. The sub-devices must belong to the Bluetooth mesh gateway.

Parameters

subList	The gateway sub-device to be managed.
localId	mesh groupId
devId	remote control's devId
categoryCode	remote control's categoryCode
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

Provided by category ThingSmartBleMeshGroup(SIGMesh).

◆ removeSubDeviceWithSubList:localId:mainDevId:categoryCode:success:failure: [2/2]

- (void) removeSubDeviceWithSubList:	(NSArray< ThingSmartDeviceModel * > *_Nonnull)	subList
localId:	(NSString *)	localId
mainDevId:	(nullable NSString *)	devId
categoryCode:	(nullable NSString *)	categoryCode
success:	(nullable ThingSuccessHandler)	success
failure:	(nullable ThingFailureError)	failure

Deletes a Bluetooth mesh sub-device group through the Bluetooth mesh gateway. The sub-devices must belong to the Bluetooth mesh gateway.

Parameters

subList	The gateway sub-device to be managed.
localId	mesh groupId
devId	remote control's devId
categoryCode	remote control's categoryCode
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

Provided by category ThingSmartBleMeshGroup(SIGMesh).

◆ removeSubDeviceWithSubList:success:failure: [1/2]

- (void) removeSubDeviceWithSubList:	(NSArray< ThingSmartDeviceModel * > *_Nonnull)	subList
success:	(nullable ThingSuccessHandler)	success
failure:	(nullable ThingFailureError)	failure

Deletes a Bluetooth mesh sub-device group through the Bluetooth mesh gateway. The sub-devices must belong to the Bluetooth mesh gateway.

Parameters

subList	The gateway sub-device to be managed.
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

Provided by category ThingSmartBleMeshGroup(SIGMesh).

◆ removeSubDeviceWithSubList:success:failure: [2/2]

- (void) removeSubDeviceWithSubList:	(NSArray< ThingSmartDeviceModel * > *_Nonnull)	subList
success:	(nullable ThingSuccessHandler)	success
failure:	(nullable ThingFailureError)	failure

Deletes a Bluetooth mesh sub-device group through the Bluetooth mesh gateway. The sub-devices must belong to the Bluetooth mesh gateway.

Parameters

subList	The gateway sub-device to be managed.
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

Provided by category ThingSmartBleMeshGroup(SIGMesh).

◆ updateMeshGroupName:success:failure: [1/2]

- (void) updateMeshGroupName:	(NSString *)	meshGroupName
success:	(ThingSuccessHandler)	success
failure:	(ThingFailureError)	failure

Modifies the mesh group name.

Parameters

meshGroupName	The mesh group name.
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

◆ updateMeshGroupName:success:failure: [2/2]

- (void) updateMeshGroupName:	(NSString *)	meshGroupName
success:	(ThingSuccessHandler)	success
failure:	(ThingFailureError)	failure

Modifies the mesh group name.

Parameters

meshGroupName	The mesh group name.
success	Called when the task is finished.
failure	Called when the task is interrupted by an error.

Property Documentation

◆ delegate

- (id< ThingSmartBleMeshGroupDelegate >) delegate

readwritenonatomicweak

Definition at line 34 of file ThingSmartBleMeshGroup.h.

◆ meshGroupModel

- (ThingSmartGroupModel *) meshGroupModel

readnonatomicstrong

Definition at line 36 of file ThingSmartBleMeshGroup.h.

The documentation for this class was generated from the following files:

/Users/humtong/Downloads/Pods_副本/ThingSmartBLEMeshKit/Build/ThingSmartBLEMeshKit.xcframework/ios-arm64_x86_64-simulator/ThingSmartBLEMeshKit.framework/Headers/ThingSmartBleMeshGroup.h
/Users/humtong/Downloads/Pods_副本/ThingSmartBLEMeshKit/Build/ThingSmartBLEMeshKit.xcframework/ios-arm64/ThingSmartBLEMeshKit.framework/Headers/ThingSmartBleMeshGroup.h

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

◆ addDeviceWithDeviceId:success:failure: [1/2]

◆ addDeviceWithDeviceId:success:failure: [2/2]

◆ addSubDeviceWithSubList:localId:mainDevId:categoryCode:success:failure: [1/2]

◆ addSubDeviceWithSubList:localId:mainDevId:categoryCode:success:failure: [2/2]

◆ addSubDeviceWithSubList:success:failure: [1/2]

◆ addSubDeviceWithSubList:success:failure: [2/2]

◆ createMeshGroupWithGroupName:meshId:localId:pcc:success:failure: [1/2]

◆ createMeshGroupWithGroupName:meshId:localId:pcc:success:failure: [2/2]

◆ deleteBleMeshGroupAddress: [1/2]

◆ deleteBleMeshGroupAddress: [2/2]

◆ editDeviceWithDeviceList:success:failure: [1/2]

◆ editDeviceWithDeviceList:success:failure: [2/2]

◆ getBleMeshGroupAddress [1/2]

◆ getBleMeshGroupAddress [2/2]

◆ getBleMeshGroupAddressFromCluondWithMeshId:success:failure: [1/2]

◆ getBleMeshGroupAddressFromCluondWithMeshId:success:failure: [2/2]

◆ getBleMeshGroupCount [1/2]

◆ getBleMeshGroupCount [2/2]

◆ getDeviceListInfoWithSuccess:failure: [1/2]

◆ getDeviceListInfoWithSuccess:failure: [2/2]

◆ getDeviveListInfoWithSuccess:failure: [1/2]

◆ getDeviveListInfoWithSuccess:failure: [2/2]

◆ initWithGroupId: [1/2]

◆ initWithGroupId: [2/2]

◆ meshGroupWithGroupId: [1/2]

◆ meshGroupWithGroupId: [2/2]

◆ NS_UNAVAILABLE [1/2]

◆ NS_UNAVAILABLE [2/2]

◆ publishDps:success:failure: [1/2]

◆ publishDps:success:failure: [2/2]

◆ publishDpsWithParams:success:failure: [1/2]

◆ publishDpsWithParams:success:failure: [2/2]

◆ removeDeviceWithDeviceId:success:failure: [1/2]

◆ removeDeviceWithDeviceId:success:failure: [2/2]

◆ removeMeshGroupWithSuccess:failure: [1/2]

◆ removeMeshGroupWithSuccess:failure: [2/2]

◆ removeSubDeviceWithSubList:localId:mainDevId:categoryCode:success:failure: [1/2]

◆ removeSubDeviceWithSubList:localId:mainDevId:categoryCode:success:failure: [2/2]

◆ removeSubDeviceWithSubList:success:failure: [1/2]

◆ removeSubDeviceWithSubList:success:failure: [2/2]

◆ updateMeshGroupName:success:failure: [1/2]

◆ updateMeshGroupName:success:failure: [2/2]

Property Documentation

◆ delegate

◆ meshGroupModel