com.mbientlab.metawear.module

Interface Settings

All Superinterfaces:

MetaWearBoard.Module

public interface Settings
extends MetaWearBoard.Module

Configures Bluetooth settings and auxiliary hardware and firmware features

Author:

Eric Tsai

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Settings.BatteryDataProducer Produces battery data that can be used with the firmware features
static class	Settings.BatteryState Wrapper class encapsulating the battery state data
static class	Settings.BleAdvertisementConfig Bluetooth LE advertising configuration
static interface	Settings.BleAdvertisementConfigEditor Interface for modifying the Bluetooth LE advertising configuration
static class	Settings.BleConnectionParameters Wrapper class containing the connection parameters
static interface	Settings.BleConnectionParametersEditor Interface for editing the Bluetooth LE connection parameters

Method Summary

Modifier and Type	Method and Description
Settings.BatteryDataProducer	battery() Gets an object to use the battery data
ActiveDataProducer	chargeStatus() Gets an object to control charging status notifications
Settings.BleAdvertisementConfigEditor	editBleAdConfig() Edit the ble advertising configuration
Settings.BleConnectionParametersEditor	editBleConnParams() Edit the ble connection parameters
Task<Observer>	onDisconnectAsync(CodeBlock codeBlock) Programs a task that will be execute on-board when a disconnect occurs
ActiveDataProducer	powerStatus() Gets an object to control power status notifications
Task<Settings.BleAdvertisementConfig>	readBleAdConfigAsync() Read the current ble advertising configuration
Task<Settings.BleConnectionParameters>	readBleConnParamsAsync() Read the current ble connection parameters
Task<Byte>	readCurrentChargeStatusAsync() Reads the current charge status
Task<Byte>	readCurrentPowerStatusAsync() Reads the current power status if available
void	startBleAdvertising() Starts ble advertising

Method Detail

startBleAdvertising

void startBleAdvertising()

Starts ble advertising

editBleAdConfig

Settings.BleAdvertisementConfigEditor editBleAdConfig()

Edit the ble advertising configuration

Returns:

Editor object to modify the settings

readBleAdConfigAsync

Task<Settings.BleAdvertisementConfig> readBleAdConfigAsync()

Read the current ble advertising configuration

Returns:

Task that is completed once the advertising config has been received

editBleConnParams

Settings.BleConnectionParametersEditor editBleConnParams()

Edit the ble connection parameters

Returns:

Editor object to modify the connection parameters

readBleConnParamsAsync

Task<Settings.BleConnectionParameters> readBleConnParamsAsync()

Read the current ble connection parameters

Returns:

Task that is completed once the connection parameters have been received

battery

Settings.BatteryDataProducer battery()

Gets an object to use the battery data

Returns:

Object representing battery data, null if battery data is not supported

powerStatus

ActiveDataProducer powerStatus()

Gets an object to control power status notifications

Returns:

Object representing power status notifications, null if power status not supported

readCurrentPowerStatusAsync

Task<Byte> readCurrentPowerStatusAsync()

Reads the current power status if available

Returns:

Task holding the power status; 1 if power source is attached, 0 otherwise

chargeStatus

ActiveDataProducer chargeStatus()

Gets an object to control charging status notifications

Returns:

Object representing charging status notifications, null if charging status not supported

readCurrentChargeStatusAsync

Task<Byte> readCurrentChargeStatusAsync()

Reads the current charge status

Returns:

Task holding the charge status; 1 if battery is charging, 0 otherwise

onDisconnectAsync

Task<Observer> onDisconnectAsync(CodeBlock codeBlock)

Programs a task that will be execute on-board when a disconnect occurs

Parameters:

codeBlock - MetaWear commands composing the task

Returns:

Task holding the result of the program request