Hi Ward,

You mentioned "After i did  those changes  and pressed on the generate button, I get some errors in the dcd file after building the code"

What are those errors ? are they compiler errors or generation errors ? if yes, please post it here.

Hi Ward,

You mentioned "After i did  those changes  and pressed on the generate button, I get some errors in the dcd file after building the code"

What are those errors ? are they compiler errors or generation errors ? in any cases, please post the log info here.

Hi Ward,

You mentioned "After i did  those changes  and pressed on the generate button, I get some errors in the dcd file after building the code"

What are those errors ? are they compiler errors or generation errors ? in any cases, please post the log info here.

Bluetooth Mesh Mobile: ADK 2.3.4 -> 3.0.x migration

1. Introduction

In principle, the update of the Bluetooth Mesh Mobile ADK to the current branch does not differ from the previous releases. The changes applied were minor which resulted in preserving the backward compatibility.

The main ones were:

• removal of the deprecated items

• minor changes in the naming of certain methods (usage stayed the same)

Note: All of these updates have been listed in the Bluetooth Mesh Mobile ADK Release Notes document for the 3.0.x versions.

2. Library update

In this section we will describe the procedure of exchanging the ADK packages in Customer's projects on both platforms. We will refer to the AN1200.1 section 4. Getting started.

2.1 iOS

On the iOS platform you need to follow the steps listed below:

• Copy the BluetoothMesh.xcframework to a folder with the new iOS project. (The framework is located under the Simplicity Studio v5 directory: SSv5 location/Eclipse/developer/sdks/gecko_sdk_suite/v3.1/app/bluetooth/ios/)

• Open the main target in your project.

• Go to the General view.

• Add the package to Frameworks, Libraries and Embedded Content.

It should be visible in Frameworks, Libraries and Embedded Content section with “Embed & Sign” chosen.

Please also make sure that when using XCFrameworks you have disabled the Bitcode in the project by following the steps:

• Select the main target in the project.

• Go to the Build Settings view.

• Search for Bitcode.

• Set Enable Bitcode to ‘No’.

Note: The AN1200.1 in section 4.1 also provides a set of screenshots for better reference.

2.2 Android

Steps for the Android platform environment can be found below:

• Open Android Studio IDE

• In the Project Structure swap new modules by executing the following list of steps for both ble_mesh-android_api-v2_high-release.aar and ble_mesh-android_api-v2_low-release.aar:

  • Open the Modules section remove the old packages and click “+” to add a new modules.

  • Select Import .JAR or .AAR Package.

  • Specify the path to the .AAR file and proceed (the packages are located under the Simplicity Studio v5 directory: SSv5 location\developer\sdks\gecko_sdk_suite\v3.1\app\bluetooth\android\ ).

  • Repeat steps the three above steps to add both .AAR modules.

  • In the Dependencies section select the app module, click “+” in the Declared Dependencies section, and select Module dependency.

  • Select the added ADK modules and proceed.

  • Make sure you have Gson dependency added to the project. If not add a new dependency as in step 5, but select Library Dependency instead. Search for com.google.code.gson:gson, select version 2.x.x, and proceed.

Note: The AN1200.1 in section 4.2 also provides a set of screenshots for better reference.

3. Project updates required

As stated in the introduction the changes made to the method names and removal of the deprecated items in the ADK 3.0.0 may force the User to also update it's application project. It is necessary to look at the lists of changed items in the sections below and make sure you apply the corrections.

3.1 iOS

3.1.1 Deprecated items removed

Note: -> points the methods replacing the removed items and lacking sign means that these methods are no longer available to use.

• SBMProvisionerConnection

  • provisionAsNode: -> provisionWithConfiguration:parameters:callback

  • provisionAsNodeWithParameters:callback: -> provisionWithConfiguration:parameters:callback

  • provisionAsProxy: -> provisionWithConfiguration:parameters:callback

  • provisionAsProxyWithParameters:callback: -> provisionWithConfiguration:parameters:callback

  • provisionAsProxyWithoutNodeIdentity: -> provisionWithConfiguration:parameters:callback

  • provisionAsProxyWithoutNodeIdentityWithParameters:callback: -> provisionWithConfiguration:parameters:callback

• SBMProvisionerOOB

  • inputDisplay:inputAction:authData: -> numericInputDisplay:authNumber or alphanumericInputDisplay:authString

• SBMGroupRemovalErrorResult

  • SuccessResultOfUnbindSigModel

  • SuccessResultOfUnbindVendorModel

  • ErrorResultOfUnbindSigModel

  • ErrorResultOfUnbindVendorModel

  • unbindedSigModels

  • unbindedVendorModels

  • notUnbindedSigModels

  • notUnbindedVendorModels

• SBMGroup

  • publicationAddress -> address

  • subscriptionAddress -> address

• SBMNetwork

  • canCreateSubnet

  • createSubnetWithName: -> createSubnetWithName:netKey:error:

  • currentIvIndex -> SBMIvIndexControl.getValue

  • requestIvIndexUpdateWithHandler: -> SBMIvIndexControl.requestUpdate:

• SBMSubnet

  • canCreateGroup

  • createGroupWithName: -> createGroupWithName:appKey:address:error:

  • createGroupWithName:appKey: -> createGroupWithName:appKey:address:error:

• SBMBluetoothMesh

  • createNetwork: -> createNetwork:error: and initializeNetwork:address:ivIndex:error:

  • createNetworkWithName:address:ivIndex: -> createNetwork:error: and initializeNetwork:address:ivIndex:error:

• SBMConfigurationControl

  • setHeartbeatSubscription:destinationAddress:period:with:errorCallback: -> setHeartbeatSubscriptionLog:destinationAddress:periodLog:with:errorCallback:

• SBMFunctionalityBinder

  • bindModels:successCallback:errorCallback: -> bindModel:successCallback:errorCallback:

  • unbindModels:successCallback:errorCallback: -> bindModel:successCallback:errorCallback:

• SBMControlRequestParameters

  • initWithTransitionTime:delayTime:requestReplay: -> initWithTransitionTime:delayTime:requestReplay:transactionId:

• SBMGenericProperty

  • initWithIdentifier:

  • initWithIdentifier:access:buffer:

• SBMGenericPropertyList

  • init

  • InitWithBuffer:

• SBMGenericPowerLevelRange

  • enum SBMGenericPowerLevelRangeState

  • status -> rangeStatus

• SBMControlValueSetVendorModel

  • localVendorModelClient -> vendorModel

• SBMControlElement

  • subscribeStatus:callback: -> SBMControlElementPublications:subscribeToGenericStatus:successHandler:errorHandler:

  • unsubscribeStatus: -> SBMTask:cancel from SBMControlElementPublications:subscrib:eToGenericStatus:successHandler:errorHandler:

• SBMControlGroup

  • getStatus:successCallback:errorCallback: -> getStatus:successHandler:errorCallback:

  • setStatus:parameters:successCallback:errorCallback: -> setStatus:parameters:successHandler:errorCallback:

• SBMVendorRegistrationSettings

• SBMVendorSubscriptionControl

3.1.2 Naming changes

• Fixed misspelled word binded to bound in properties:

  • SBMModel:boundGroups

  • SBMGroupRemovalErrorResult:unboundNodes

  • SBMGroupRemovalErrorResult:notUnboundNodes

  • SBMModelImport:boundGroups

• Fixed misspelled word Lightning to Lighting in classes:

  • SBMLightingCTLDefault

  • SBMLightingCTLGet

  • SBMLightingCTLSet

  • SBMLightingCTLTemperature

  • SBMLightingCTLTemperatureRange

  • SBMLightingLightnessActual

  • SBMLightingLightnessDefault

  • SBMLightingLightnessLast

  • SBMLightingLightnessLinear

  • SBMLightingLightnessRange

3.1.3 Other API changes

• Error codes in SBMStackError domain have been changed

• SBMProvisionerOOBResult enum is now consequent

3.2 Android

3.2.1 Deprecated items removed

Note: -> points the methods replacing the removed items and lacking sign means that these methods are no longer available to use.

• Group

  • getPublicationAddress() -> getAddress()

  • getSubscriptionAddress() -> getAddress()

• Subnet

  • createGroup(String name) -> createGroup(String name, AppKey appKey, Integer address)

  • createGroup(String name, AppKey appKey) -> createGroup(String name, AppKey appKey, Integer address)

• BluetoothMesh

  • createNetwork(String name, int address, int ivIndex) -> createNetwork(String name)

• ProvisionerOOB

  • publicKeyAllowed() -> isPublicKeyAllowed()

  • authMethodsAllowed() -> getAllowedAuthMethods()

  • outputActionsAllowed() -> getAllowedOutputActions()

  • inputActionsAllowed() -> getAllowedInputActions()

  • authRequest()

  • inputOobDisplay()

• ControlGroup

  • getStatus(T model, GetGroupStatusCallback<T> callback) -> getStatus(T model, final GenericGroupHandler<T> handler)

  • setStatus(T model, ControlRequestParameters parameters, SetGroupStatusCallback<T> callback) -> setStatus(T model, ControlRequestParameters parameters, GenericGroupHandler<T> handler)

• FunctionalityBinder

  • bindModels(final List<Model> models, final FunctionalityBinderCallback callback) -> bindModel(Model model, FunctionalityBinderCallback callback)

  • unbindModels(final List<Model> models, final FunctionalityBinderCallback callback) -> unbindModel(Model model, FunctionalityBinderCallback callback)

• ControlRequestParameters

  • ControlRequestParameters(int transitionTime, int delayTime, boolean requestReply) -> ControlRequestParameters(int transitionTime, int delayTime, boolean requestReply, int transactionId)

• VendorSubscriptionControl (Use LocalVendorSettings instead)

• VendorRegistrationSettings (Use LocalVendorSettings instead)

• ProvisionerConnection

  • provisionAsNode(...), provisionAsProxy(...), provisionAsProxyWithoutNodeIdentity(...) -> provision(ProvisionerConfiguration provisionerConfiguration, NodeProperties,nodeProperties, final ProvisioningCallback callback)

• Network

  • getCurrentIvIndex() -> IvIndexControl.getValue()

  • requestIvIndexUpdate(IvIndexUpdateEventHandler handler) -> IvIndexControl.requestUpdate()

• SubscriptionControl

  • publicationSettings(PublicationSettingsCallback callback) -> publicationSettings(PublicationSettingsGenericCallback callback)

  • setPublicationSettings(PublicationSettings publicationSettings, PublicationSettingsCallback callback) -> setPublicationSettings(PublicationSettings publicationSettings, PublicationSettingsGenericCallback callback)

  • clearPublicationSettings(PublicationSettingsCallback callback) -> clearPublicationSettings(PublicationSettingsGenericCallback callback)

  • subscriptionSettings(SubscriptionSettingsSetCallback callback) -> subscriptionSettings(SubscriptionSettingsSetGenericCallback callback)

  • setSubscriptionSettings(SubscriptionSettings subscriptionSettings, SubscriptionSettingsCallback callback) -> setSubscriptionSettings(SubscriptionSettings subscriptionSettings, SubscriptionSettingsGenericCallback callback)

  • clearSubscriptionSettings(SubscriptionSettingsSetCallback callback) -> clearSubscriptionSettings(SubscriptionSettingsSetGenericCallback callback)

  • addSubscriptionSettings(SubscriptionSettings subscriptionSettings, SubscriptionSettingsCallback callback) -> addSubscriptionSettings(SubscriptionSettings subscriptionSettings, SubscriptionSettingsGenericCallback callback)

  • removeSubscriptionSettings(SubscriptionSettings subscriptionSettings, SubscriptionSettingsCallback callback) -> removeSubscriptionSettings(SubscriptionSettings subscriptionSettings, SubscriptionSettingsGenericCallback callback)

3.2.2 Naming changes

• Fixed misspelled word Lightning to Lighting in classes:

  • LightingCTLDefault.java

  • LightingCTLGet.java

  • LightingCTLSet.java

  • LightingCTLTemperature.java

  • LightingCTLTemperatureRange.java

  • LightingLightnessActual.java

  • LightingLightnessDefault.java

  • LightingLightnessLast.java

  • LightingLightnessLinear.java

  • LightingLightnessRange.java

• Fixed misspelled word binded to bound in:

  • LocalVendorModel#addBoundAppKey()

  • LocalVendorModel#removeUnboundKey()

  • LocalVendorModel#getBoundAppKeys()

  • Model#getBoundGroups()

• Other renames:

  • BluetoothMesh.createNetworkWithoutSubnet to BluetoothMesh.createNetwork

  • PublicationSettingsGenericCallback to PublicationSettingsCallback

  • SubscriptionSettingsGenericCallback to SubscriptionSettingsCallback

  • SubscriptionSettingsSetGenericCallback to SubscriptionSettingsSetCallback

  • publicKeyAllowed to isPublicKeyAllowed

  • setOfAuthMethodsAllowed to getAllowedAuthMethods

  • setOfOutputActionsAllowed to getAllowedOutputActions

  • setOfInputActionsAllowed to getAllowedInputActions

3.2.3 Other changes

• Function refreshGattServices in class ConnectableDevice is now abstract.

• Function refreshBluetoothDevice in class ConnectableDevice is now abstract.

• SubscriptionControl now has a constructor with Model parameter.

• SubscriptionControl.getModel now returns Model.

• Changed type of NodeSettings.configComplete to primitive.

• Changed NodeSettings.features property to nullable.

• Deleted the following error types:

  • OPERATION_NOT_SUPPORTED

  • INTERRUPTED_EXCEPTION

  • NOT_IN_ANY_SUBNET

  • CONNECT_TO_DEVICE_TIMEOUT

  • COULD_NOT_WRITE_TO_CHARACTERISTIC

  • COULD_NOT_DISCONNECT_FROM_DEVICE

  • NOT_CONNECTED_TO_NETWORK

  • CANNOT_REMOVE_PRIMARY_SUBNET

4. Conclusion

With the information listed in the above Document it should be possible for the Users to successfully switch an existing project based on the older ADK versions to the Bluetooth Mesh Mobile ADK 3.0.0. However, in case of any inclarities, please do not hesitate to contact us via a private support case or feel free to comment below.

Warning: We would also like to highlight that for the best reliability we always recommend to use the Bluetooth Mesh Mobile ADK and Bluetooth Mesh Embedded SDK in combination from the same release.

Hi Richard,

Have you tried to reinit the stack ? I mean by that reinit the mesh classes.

Also which SDK are you using ?

Hi Marco,

I think the best at this point would be for you to create a support case and send me your project so I can have a look.

One more thing, additionally to making sure the the config client model to your element is present on the provisioner, have you set the provisioning config properly ?

Let me know

Hi Omar,

when installing Studio, have you installed the Jlink USB driver ?

please refer https://www.silabs.com/community/wireless/bluetooth/forum.topic.html/_-MHXT

summary: it is now hard limit inside out stack, can't change. Scene server iterates through the models to sum up the required space for a single entry, of course the final sum is depending on the DCD. That part should be fine, but the number of scene entries is not configurable via the SDK, unfortunately. 

Hi Marco,

I assume the snippet of code that you wrote there work as follow :

1. Create a network on the provisioner
2. When a node is provisioned, you get the provisioned event and as a result, the server address.
3. Trying to get the composition data page 0 of the device.

Is that correct ? 

Is this code running on provisioner ? This would be mandatory as a config client model has to be supported.

You mentioned "Sometimes the provisioning works" can you elaborate a bit on that versus when it fails ?