Skip to main content
Version: v3+

mstBuildProfile

Start from API_LEVEL 3.0 . Please refer to API_LEVEL.

Creating a Profile connection.

Type​

function mstBuildProfile(profile: ProfileObj): Result

Parameters​

ProfileObj​

PropertyTypeRequiredDefaultValueDescriptionAPI_LEVEL
pairbooleanY-Whether to pair automatically3.0
idnumberY-Connection ID3.0
profilestringY-Profile Name3.0
devArrayBufferY-Device MAC address, 6 bytes long, Uint8Array view recommended3.0
lennumberY-list array length3.0
listArray<ServicesObj>Y-Services list array3.0

ServicesObj​

PropertyTypeRequiredDefaultValueDescriptionAPI_LEVEL
lennumberY-list array length3.0
listArray<ServiceObj>Y-Service array3.0

ServiceObj​

PropertyTypeRequiredDefaultValueDescriptionAPI_LEVEL
uuidstringY-Service UUID3.0
permissionnumberN0Permission control, default 0 No control3.0
len1numberY-Characteristic array length3.0
listArray<CharacteristicObj>Y-Characteristic length3.0

CharacteristicObj​

PropertyTypeRequiredDefaultValueDescriptionAPI_LEVEL
uuidstringY-Characteristic UUID3.0
permissionnumberN0Permission control, default 0 No control3.0
lennumberY-Descriptor array length3.0
listArray<DescriptorObj>Y-Descriptor array3.0

DescriptorObj​

PropertyTypeRequiredDefaultValueDescriptionAPI_LEVEL
uuidstringY-Descriptor UUID3.0
permissionnumberN0Permission control, default 0 No control3.0

Result​

TypeDescription
booleanThe result of the function call, true means success, false means failure

Example​

import { mstBuildProfile } from '@zos/ble'

// ...