Official Sheffield ARMBand micro:bit program
Diff: microbit/source/MicroBit.cpp
- Revision:
- 0:b9164b348919
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/microbit/source/MicroBit.cpp Mon Oct 17 12:41:20 2016 +0000 @@ -0,0 +1,223 @@ +/* +The MIT License (MIT) + +Copyright (c) 2016 British Broadcasting Corporation. +This software is provided by Lancaster University by arrangement with the BBC. + +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the "Software"), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL +THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. +*/ + +#include "MicroBitConfig.h" +/* + * The underlying Nordic libraries that support BLE do not compile cleanly with the stringent GCC settings we employ + * If we're compiling under GCC, then we suppress any warnings generated from this code (but not the rest of the DAL) + * The ARM cc compiler is more tolerant. We don't test __GNUC__ here to detect GCC as ARMCC also typically sets this + * as a compatability option, but does not support the options used... + */ +#if !defined(__arm) +#pragma GCC diagnostic ignored "-Wunused-function" +#pragma GCC diagnostic push +#pragma GCC diagnostic ignored "-Wunused-parameter" +#endif + +#include "MicroBit.h" + +#include "nrf_soc.h" + +/* + * Return to our predefined compiler settings. + */ +#if !defined(__arm) +#pragma GCC diagnostic pop +#endif + +#if CONFIG_ENABLED(MICROBIT_DBG) +// We create and initialize to NULL here, but MicroBitSerial will automatically update this as needed in its constructor. +RawSerial* SERIAL_DEBUG = NULL; +#endif + +/** + * Constructor. + * + * Create a representation of a MicroBit device, which includes member variables + * that represent various device drivers used to control aspects of the micro:bit. + */ +MicroBit::MicroBit() : + serial(USBTX, USBRX), + resetButton(MICROBIT_PIN_BUTTON_RESET), + storage(), + i2c(I2C_SDA0, I2C_SCL0), + messageBus(), + display(), + buttonA(MICROBIT_PIN_BUTTON_A, MICROBIT_ID_BUTTON_A), + buttonB(MICROBIT_PIN_BUTTON_B, MICROBIT_ID_BUTTON_B), + buttonAB(MICROBIT_ID_BUTTON_A,MICROBIT_ID_BUTTON_B, MICROBIT_ID_BUTTON_AB), + accelerometer(i2c), + compass(i2c, accelerometer, storage), + compassCalibrator(compass, accelerometer, display), + thermometer(storage), + io(MICROBIT_ID_IO_P0,MICROBIT_ID_IO_P1,MICROBIT_ID_IO_P2, + MICROBIT_ID_IO_P3,MICROBIT_ID_IO_P4,MICROBIT_ID_IO_P5, + MICROBIT_ID_IO_P6,MICROBIT_ID_IO_P7,MICROBIT_ID_IO_P8, + MICROBIT_ID_IO_P9,MICROBIT_ID_IO_P10,MICROBIT_ID_IO_P11, + MICROBIT_ID_IO_P12,MICROBIT_ID_IO_P13,MICROBIT_ID_IO_P14, + MICROBIT_ID_IO_P15,MICROBIT_ID_IO_P16,MICROBIT_ID_IO_P19, + MICROBIT_ID_IO_P20), + bleManager(storage), + radio(), + ble(NULL) +{ + // Clear our status + status = 0; + + // Bring up soft reset functionality as soon as possible. + resetButton.mode(PullUp); + resetButton.fall(this, &MicroBit::reset); +} + +/** + * Post constructor initialisation method. + * + * This call will initialised the scheduler, memory allocator and Bluetooth stack. + * + * This is required as the Bluetooth stack can't be brought up in a + * static context i.e. in a constructor. + * + * @code + * uBit.init(); + * @endcode + * + * @note This method must be called before user code utilises any functionality + * contained by uBit. + */ +void MicroBit::init() +{ + if (status & MICROBIT_INITIALIZED) + return; + +#if CONFIG_ENABLED(MICROBIT_HEAP_ALLOCATOR) + // Bring up a nested heap allocator. + microbit_create_nested_heap(MICROBIT_NESTED_HEAP_SIZE); +#endif + + // Bring up fiber scheduler. + scheduler_init(messageBus); + + // Seed our random number generator + seedRandom(); + + // Create an event handler to trap any handlers being created for I2C services. + // We do this to enable initialisation of those services only when they're used, + // which saves processor time, memeory and battery life. + messageBus.listen(MICROBIT_ID_MESSAGE_BUS_LISTENER, MICROBIT_EVT_ANY, this, &MicroBit::onListenerRegisteredEvent); + + status |= MICROBIT_INITIALIZED; + +#if CONFIG_ENABLED(MICROBIT_BLE_PAIRING_MODE) + // Test if we need to enter BLE pairing mode... + int i=0; + sleep(100); + while (buttonA.isPressed() && buttonB.isPressed() && i<10) + { + sleep(100); + i++; + + if (i == 10) + { +#if CONFIG_ENABLED(MICROBIT_HEAP_ALLOCATOR) && CONFIG_ENABLED(MICROBIT_HEAP_REUSE_SD) + microbit_create_heap(MICROBIT_SD_GATT_TABLE_START + MICROBIT_SD_GATT_TABLE_SIZE, MICROBIT_SD_LIMIT); +#endif + // Start the BLE stack, if it isn't already running. + if (!ble) + { + bleManager.init(getName(), getSerial(), messageBus, true); + ble = bleManager.ble; + } + + // Enter pairing mode, using the LED matrix for any necessary pairing operations + bleManager.pairingMode(display, buttonA); + } + } +#endif + + // Attempt to bring up a second heap region, using unused memory normally reserved for Soft Device. +#if CONFIG_ENABLED(MICROBIT_HEAP_ALLOCATOR) && CONFIG_ENABLED(MICROBIT_HEAP_REUSE_SD) +#if CONFIG_ENABLED(MICROBIT_BLE_ENABLED) + microbit_create_heap(MICROBIT_SD_GATT_TABLE_START + MICROBIT_SD_GATT_TABLE_SIZE, MICROBIT_SD_LIMIT); +#else + microbit_create_heap(MICROBIT_SRAM_BASE, MICROBIT_SD_LIMIT); +#endif +#endif + +#if CONFIG_ENABLED(MICROBIT_BLE_ENABLED) + // Start the BLE stack, if it isn't already running. + if (!ble) + { + bleManager.init(getName(), getSerial(), messageBus, false); + ble = bleManager.ble; + } +#endif +} + +/** + * A listener to perform actions as a result of Message Bus reflection. + * + * In some cases we want to perform lazy instantiation of components, such as + * the compass and the accelerometer, where we only want to add them to the idle + * fiber when someone has the intention of using these components. + */ +void MicroBit::onListenerRegisteredEvent(MicroBitEvent evt) +{ + switch(evt.value) + { + case MICROBIT_ID_BUTTON_AB: + // A user has registered to receive events from the buttonAB multibutton. + // Disable click events from being generated by ButtonA and ButtonB, and defer the + // control of this to the multibutton handler. + // + // This way, buttons look independent unless a buttonAB is requested, at which + // point button A+B clicks can be correclty handled without breaking + // causal ordering. + buttonA.setEventConfiguration(MICROBIT_BUTTON_SIMPLE_EVENTS); + buttonB.setEventConfiguration(MICROBIT_BUTTON_SIMPLE_EVENTS); + buttonAB.setEventConfiguration(MICROBIT_BUTTON_ALL_EVENTS); + break; + + case MICROBIT_ID_COMPASS: + // A listener has been registered for the compass. + // The compass uses lazy instantiation, we just need to read the data once to start it running. + // Touch the compass through the heading() function to ensure it is calibrated. if it isn't this will launch any associated calibration algorithms. + compass.heading(); + + break; + + case MICROBIT_ID_ACCELEROMETER: + case MICROBIT_ID_GESTURE: + // A listener has been registered for the accelerometer. + // The accelerometer uses lazy instantiation, we just need to read the data once to start it running. + accelerometer.updateSample(); + break; + + case MICROBIT_ID_THERMOMETER: + // A listener has been registered for the thermometer. + // The thermometer uses lazy instantiation, we just need to read the data once to start it running. + thermometer.updateSample(); + break; + } +} \ No newline at end of file