Documentation for Bluetooth IO Pin service block.

Addition of event handler blocks for Bluetooth connection state changes.
This commit is contained in:
Martin Woolley
2016-06-20 08:39:51 +01:00
parent 1df118fa19
commit 22c03dfd7a
6 changed files with 93 additions and 13 deletions

View File

@ -5,7 +5,7 @@ using namespace pxt;
//% color=#0082FB weight=20
namespace bluetooth {
/**
* Starts the Bluetooth IO pin service
* Starts the Bluetooth IO pin service.
*/
//% help=bluetooth/start-io-pin-service
//% blockId=bluetooth_start_io_pin_service block="bluetooth io pin service" blockGap=8
@ -23,7 +23,7 @@ namespace bluetooth {
}
/**
* Starts the temperature service
* Starts the Bluetooth temperature service
*/
//% help=bluetooth/start-temperature-service
//% blockId=bluetooth_start_temperature_service block="bluetooth temperature service" blockGap=8
@ -32,7 +32,7 @@ namespace bluetooth {
}
/**
* Starts the magnetometer service
* Starts the Bluetooth magnetometer service
*/
//% help=bluetooth/start-magnetometer-service
//% blockId=bluetooth_start_magnetometer_service block="bluetooth magnetometer service" blockGap=8
@ -41,7 +41,7 @@ namespace bluetooth {
}
/**
* Starts the accelerometer service
* Starts the Bluetooth accelerometer service
*/
//% help=bluetooth/start-accelerometer-service
//% blockId=bluetooth_start_accelerometer_service block="bluetooth accelerometer service" blockGap=8
@ -50,11 +50,33 @@ namespace bluetooth {
}
/**
* Starts the button service
* Starts the Bluetooth button service
*/
//% help=bluetooth/start-button-service
//% blockId=bluetooth_start_button_service block="bluetooth button service" blockGap=8
void startButtonService() {
new MicroBitButtonService(*uBit.ble);
}
/**
* Register code to run when the micro:bit is connected to over Bluetooth
* @param body Code to run when a Bluetooth connection is established
*/
//% help=bluetooth/on-bluetooth-connected
//% blockId=bluetooth_on_connected block="on bluetooth connected"
void onBluetoothConnected(Action body) {
registerWithDal(MICROBIT_ID_BLE, MICROBIT_BLE_EVT_CONNECTED, body);
}
/**
* Register code to run when a bluetooth connection to the micro:bit is lost
* @param body Code to run when a Bluetooth connection is lost
*/
//% help=bluetooth/on-bluetooth-disconnected
//% blockId=bluetooth_on_disconnected block="on bluetooth disconnected"
void onBluetoothDisconnected(Action body) {
registerWithDal(MICROBIT_ID_BLE, MICROBIT_BLE_EVT_DISCONNECTED, body);
}
}