MetaWear C# SDK  1.2.0
C# API for MbientLab's sensor platform
Public Member Functions | List of all members
MbientLab.MetaWear.Peripheral.IIBeacon Interface Reference

Apple developed protocol for Bluetooth LE proximity sensing More...

Inheritance diagram for MbientLab.MetaWear.Peripheral.IIBeacon:
MbientLab.MetaWear.IModule

Public Member Functions

void Enable ()
 Enable IBeacon advertising. You will need to disconnect from the board to advertise as an IBeacon More...
 
void Disable ()
 Disable IBeacon advertising More...
 
void Configure (Guid? uuid=null, ushort? major=null, ushort? minor=null, IDataToken majorToken=null, IDataToken minorToken=null, sbyte? txPower=null, sbyte? rxPower=null, ushort? period=null)
 Configure IBeacon advertising settings. Parameters that are not set will be ignored. More...
 
Task< ConfigurationReadConfigAsync ()
 Read the current IBeacon configuration More...
 

Detailed Description

Apple developed protocol for Bluetooth LE proximity sensing

Member Function Documentation

◆ Configure()

void MbientLab.MetaWear.Peripheral.IIBeacon.Configure ( Guid?  uuid = null,
ushort?  major = null,
ushort?  minor = null,
IDataToken  majorToken = null,
IDataToken  minorToken = null,
sbyte?  txPower = null,
sbyte?  rxPower = null,
ushort?  period = null 
)

Configure IBeacon advertising settings. Parameters that are not set will be ignored.

Parameters
uuidIBeacon UUID
majorIBeacon major value, takes precedence over the
majorToken
parameter
majorTokenData token representing the sensor data to use as the new major value
minorIBeacon minor value, takes precedence over the
minorToken
parameter
minorTokenData token representing the sensor data to use as the new minor value
txPowerIBeacon transmitting power
rxPowerIBeacon receiving power
periodIBeacon advertising period, in milliseconds (ms)

◆ Disable()

void MbientLab.MetaWear.Peripheral.IIBeacon.Disable ( )

Disable IBeacon advertising

◆ Enable()

void MbientLab.MetaWear.Peripheral.IIBeacon.Enable ( )

Enable IBeacon advertising. You will need to disconnect from the board to advertise as an IBeacon

◆ ReadConfigAsync()

Task<Configuration> MbientLab.MetaWear.Peripheral.IIBeacon.ReadConfigAsync ( )

Read the current IBeacon configuration

Returns
IBeacon configuration
Exceptions
TimeoutExceptionIf the read takes too long

The documentation for this interface was generated from the following file: