Jean Vanderpelen / microbit

developer.mbed.org branch of Lancaster University's microbit library. The real home for this is https://github.com/lancaster-university/microbit

Dependencies:   microbit-dal

Dependents:   MB02 asteroid_shooting

source/MicroBit.cpp@0:ee31ccbe9919, 2019-12-23 (annotated)

Committer:
ikkeje
Date:
Mon Dec 23 10:31:28 2019 +0000
Revision:
0:ee31ccbe9919
1.1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ikkeje 0:ee31ccbe9919 1 /*
ikkeje 0:ee31ccbe9919 2 The MIT License (MIT)
ikkeje 0:ee31ccbe9919 3
ikkeje 0:ee31ccbe9919 4 Copyright (c) 2016 British Broadcasting Corporation.
ikkeje 0:ee31ccbe9919 5 This software is provided by Lancaster University by arrangement with the BBC.
ikkeje 0:ee31ccbe9919 6
ikkeje 0:ee31ccbe9919 7 Permission is hereby granted, free of charge, to any person obtaining a
ikkeje 0:ee31ccbe9919 8 copy of this software and associated documentation files (the "Software"),
ikkeje 0:ee31ccbe9919 9 to deal in the Software without restriction, including without limitation
ikkeje 0:ee31ccbe9919 10 the rights to use, copy, modify, merge, publish, distribute, sublicense,
ikkeje 0:ee31ccbe9919 11 and/or sell copies of the Software, and to permit persons to whom the
ikkeje 0:ee31ccbe9919 12 Software is furnished to do so, subject to the following conditions:
ikkeje 0:ee31ccbe9919 13
ikkeje 0:ee31ccbe9919 14 The above copyright notice and this permission notice shall be included in
ikkeje 0:ee31ccbe9919 15 all copies or substantial portions of the Software.
ikkeje 0:ee31ccbe9919 16
ikkeje 0:ee31ccbe9919 17 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
ikkeje 0:ee31ccbe9919 18 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
ikkeje 0:ee31ccbe9919 19 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
ikkeje 0:ee31ccbe9919 20 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
ikkeje 0:ee31ccbe9919 21 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
ikkeje 0:ee31ccbe9919 22 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
ikkeje 0:ee31ccbe9919 23 DEALINGS IN THE SOFTWARE.
ikkeje 0:ee31ccbe9919 24 */
ikkeje 0:ee31ccbe9919 25
ikkeje 0:ee31ccbe9919 26 #include "MicroBitConfig.h"
ikkeje 0:ee31ccbe9919 27 /*
ikkeje 0:ee31ccbe9919 28 * The underlying Nordic libraries that support BLE do not compile cleanly with the stringent GCC settings we employ
ikkeje 0:ee31ccbe9919 29 * If we're compiling under GCC, then we suppress any warnings generated from this code (but not the rest of the DAL)
ikkeje 0:ee31ccbe9919 30 * The ARM cc compiler is more tolerant. We don't test __GNUC__ here to detect GCC as ARMCC also typically sets this
ikkeje 0:ee31ccbe9919 31 * as a compatability option, but does not support the options used...
ikkeje 0:ee31ccbe9919 32 */
ikkeje 0:ee31ccbe9919 33 #if !defined(__arm)
ikkeje 0:ee31ccbe9919 34 #pragma GCC diagnostic ignored "-Wunused-function"
ikkeje 0:ee31ccbe9919 35 #pragma GCC diagnostic push
ikkeje 0:ee31ccbe9919 36 #pragma GCC diagnostic ignored "-Wunused-parameter"
ikkeje 0:ee31ccbe9919 37 #endif
ikkeje 0:ee31ccbe9919 38
ikkeje 0:ee31ccbe9919 39 #include "MicroBit.h"
ikkeje 0:ee31ccbe9919 40
ikkeje 0:ee31ccbe9919 41 #include "nrf_soc.h"
ikkeje 0:ee31ccbe9919 42
ikkeje 0:ee31ccbe9919 43 /*
ikkeje 0:ee31ccbe9919 44 * Return to our predefined compiler settings.
ikkeje 0:ee31ccbe9919 45 */
ikkeje 0:ee31ccbe9919 46 #if !defined(__arm)
ikkeje 0:ee31ccbe9919 47 #pragma GCC diagnostic pop
ikkeje 0:ee31ccbe9919 48 #endif
ikkeje 0:ee31ccbe9919 49
ikkeje 0:ee31ccbe9919 50 #if CONFIG_ENABLED(MICROBIT_DBG)
ikkeje 0:ee31ccbe9919 51 // We create and initialize to NULL here, but MicroBitSerial will automatically update this as needed in its constructor.
ikkeje 0:ee31ccbe9919 52 RawSerial* SERIAL_DEBUG = NULL;
ikkeje 0:ee31ccbe9919 53 #endif
ikkeje 0:ee31ccbe9919 54
ikkeje 0:ee31ccbe9919 55 /**
ikkeje 0:ee31ccbe9919 56 * Constructor.
ikkeje 0:ee31ccbe9919 57 *
ikkeje 0:ee31ccbe9919 58 * Create a representation of a MicroBit device, which includes member variables
ikkeje 0:ee31ccbe9919 59 * that represent various device drivers used to control aspects of the micro:bit.
ikkeje 0:ee31ccbe9919 60 */
ikkeje 0:ee31ccbe9919 61 MicroBit::MicroBit() :
ikkeje 0:ee31ccbe9919 62 serial(USBTX, USBRX),
ikkeje 0:ee31ccbe9919 63 resetButton(MICROBIT_PIN_BUTTON_RESET),
ikkeje 0:ee31ccbe9919 64 storage(),
ikkeje 0:ee31ccbe9919 65 i2c(I2C_SDA0, I2C_SCL0),
ikkeje 0:ee31ccbe9919 66 messageBus(),
ikkeje 0:ee31ccbe9919 67 display(),
ikkeje 0:ee31ccbe9919 68 buttonA(MICROBIT_PIN_BUTTON_A, MICROBIT_ID_BUTTON_A),
ikkeje 0:ee31ccbe9919 69 buttonB(MICROBIT_PIN_BUTTON_B, MICROBIT_ID_BUTTON_B),
ikkeje 0:ee31ccbe9919 70 buttonAB(MICROBIT_ID_BUTTON_A,MICROBIT_ID_BUTTON_B, MICROBIT_ID_BUTTON_AB),
ikkeje 0:ee31ccbe9919 71 accelerometer(i2c),
ikkeje 0:ee31ccbe9919 72 compass(i2c, accelerometer, storage),
ikkeje 0:ee31ccbe9919 73 compassCalibrator(compass, accelerometer, display),
ikkeje 0:ee31ccbe9919 74 thermometer(storage),
ikkeje 0:ee31ccbe9919 75 io(MICROBIT_ID_IO_P0,MICROBIT_ID_IO_P1,MICROBIT_ID_IO_P2,
ikkeje 0:ee31ccbe9919 76 MICROBIT_ID_IO_P3,MICROBIT_ID_IO_P4,MICROBIT_ID_IO_P5,
ikkeje 0:ee31ccbe9919 77 MICROBIT_ID_IO_P6,MICROBIT_ID_IO_P7,MICROBIT_ID_IO_P8,
ikkeje 0:ee31ccbe9919 78 MICROBIT_ID_IO_P9,MICROBIT_ID_IO_P10,MICROBIT_ID_IO_P11,
ikkeje 0:ee31ccbe9919 79 MICROBIT_ID_IO_P12,MICROBIT_ID_IO_P13,MICROBIT_ID_IO_P14,
ikkeje 0:ee31ccbe9919 80 MICROBIT_ID_IO_P15,MICROBIT_ID_IO_P16,MICROBIT_ID_IO_P19,
ikkeje 0:ee31ccbe9919 81 MICROBIT_ID_IO_P20),
ikkeje 0:ee31ccbe9919 82 bleManager(storage),
ikkeje 0:ee31ccbe9919 83 radio(),
ikkeje 0:ee31ccbe9919 84 ble(NULL)
ikkeje 0:ee31ccbe9919 85 {
ikkeje 0:ee31ccbe9919 86 // Clear our status
ikkeje 0:ee31ccbe9919 87 status = 0;
ikkeje 0:ee31ccbe9919 88
ikkeje 0:ee31ccbe9919 89 // Bring up soft reset functionality as soon as possible.
ikkeje 0:ee31ccbe9919 90 resetButton.mode(PullUp);
ikkeje 0:ee31ccbe9919 91 resetButton.fall(this, &MicroBit::reset);
ikkeje 0:ee31ccbe9919 92 }
ikkeje 0:ee31ccbe9919 93
ikkeje 0:ee31ccbe9919 94 /**
ikkeje 0:ee31ccbe9919 95 * Post constructor initialisation method.
ikkeje 0:ee31ccbe9919 96 *
ikkeje 0:ee31ccbe9919 97 * This call will initialised the scheduler, memory allocator and Bluetooth stack.
ikkeje 0:ee31ccbe9919 98 *
ikkeje 0:ee31ccbe9919 99 * This is required as the Bluetooth stack can't be brought up in a
ikkeje 0:ee31ccbe9919 100 * static context i.e. in a constructor.
ikkeje 0:ee31ccbe9919 101 *
ikkeje 0:ee31ccbe9919 102 * @code
ikkeje 0:ee31ccbe9919 103 * uBit.init();
ikkeje 0:ee31ccbe9919 104 * @endcode
ikkeje 0:ee31ccbe9919 105 *
ikkeje 0:ee31ccbe9919 106 * @note This method must be called before user code utilises any functionality
ikkeje 0:ee31ccbe9919 107 * contained by uBit.
ikkeje 0:ee31ccbe9919 108 */
ikkeje 0:ee31ccbe9919 109 void MicroBit::init()
ikkeje 0:ee31ccbe9919 110 {
ikkeje 0:ee31ccbe9919 111 if (status & MICROBIT_INITIALIZED)
ikkeje 0:ee31ccbe9919 112 return;
ikkeje 0:ee31ccbe9919 113
ikkeje 0:ee31ccbe9919 114 #if CONFIG_ENABLED(MICROBIT_HEAP_ALLOCATOR)
ikkeje 0:ee31ccbe9919 115 // Bring up a nested heap allocator.
ikkeje 0:ee31ccbe9919 116 microbit_create_nested_heap(MICROBIT_NESTED_HEAP_SIZE);
ikkeje 0:ee31ccbe9919 117 #endif
ikkeje 0:ee31ccbe9919 118
ikkeje 0:ee31ccbe9919 119 // Bring up fiber scheduler.
ikkeje 0:ee31ccbe9919 120 scheduler_init(messageBus);
ikkeje 0:ee31ccbe9919 121
ikkeje 0:ee31ccbe9919 122 // Seed our random number generator
ikkeje 0:ee31ccbe9919 123 seedRandom();
ikkeje 0:ee31ccbe9919 124
ikkeje 0:ee31ccbe9919 125 // Create an event handler to trap any handlers being created for I2C services.
ikkeje 0:ee31ccbe9919 126 // We do this to enable initialisation of those services only when they're used,
ikkeje 0:ee31ccbe9919 127 // which saves processor time, memeory and battery life.
ikkeje 0:ee31ccbe9919 128 messageBus.listen(MICROBIT_ID_MESSAGE_BUS_LISTENER, MICROBIT_EVT_ANY, this, &MicroBit::onListenerRegisteredEvent);
ikkeje 0:ee31ccbe9919 129
ikkeje 0:ee31ccbe9919 130 status |= MICROBIT_INITIALIZED;
ikkeje 0:ee31ccbe9919 131
ikkeje 0:ee31ccbe9919 132 #if CONFIG_ENABLED(MICROBIT_BLE_PAIRING_MODE)
ikkeje 0:ee31ccbe9919 133 // Test if we need to enter BLE pairing mode...
ikkeje 0:ee31ccbe9919 134 int i=0;
ikkeje 0:ee31ccbe9919 135 sleep(100);
ikkeje 0:ee31ccbe9919 136 while (buttonA.isPressed() && buttonB.isPressed() && i<10)
ikkeje 0:ee31ccbe9919 137 {
ikkeje 0:ee31ccbe9919 138 sleep(100);
ikkeje 0:ee31ccbe9919 139 i++;
ikkeje 0:ee31ccbe9919 140
ikkeje 0:ee31ccbe9919 141 if (i == 10)
ikkeje 0:ee31ccbe9919 142 {
ikkeje 0:ee31ccbe9919 143 #if CONFIG_ENABLED(MICROBIT_HEAP_ALLOCATOR) && CONFIG_ENABLED(MICROBIT_HEAP_REUSE_SD)
ikkeje 0:ee31ccbe9919 144 microbit_create_heap(MICROBIT_SD_GATT_TABLE_START + MICROBIT_SD_GATT_TABLE_SIZE, MICROBIT_SD_LIMIT);
ikkeje 0:ee31ccbe9919 145 #endif
ikkeje 0:ee31ccbe9919 146 // Start the BLE stack, if it isn't already running.
ikkeje 0:ee31ccbe9919 147 if (!ble)
ikkeje 0:ee31ccbe9919 148 {
ikkeje 0:ee31ccbe9919 149 bleManager.init(getName(), getSerial(), messageBus, true);
ikkeje 0:ee31ccbe9919 150 ble = bleManager.ble;
ikkeje 0:ee31ccbe9919 151 }
ikkeje 0:ee31ccbe9919 152
ikkeje 0:ee31ccbe9919 153 // Enter pairing mode, using the LED matrix for any necessary pairing operations
ikkeje 0:ee31ccbe9919 154 bleManager.pairingMode(display, buttonA);
ikkeje 0:ee31ccbe9919 155 }
ikkeje 0:ee31ccbe9919 156 }
ikkeje 0:ee31ccbe9919 157 #endif
ikkeje 0:ee31ccbe9919 158
ikkeje 0:ee31ccbe9919 159 // Attempt to bring up a second heap region, using unused memory normally reserved for Soft Device.
ikkeje 0:ee31ccbe9919 160 #if CONFIG_ENABLED(MICROBIT_HEAP_ALLOCATOR) && CONFIG_ENABLED(MICROBIT_HEAP_REUSE_SD)
ikkeje 0:ee31ccbe9919 161 #if CONFIG_ENABLED(MICROBIT_BLE_ENABLED)
ikkeje 0:ee31ccbe9919 162 microbit_create_heap(MICROBIT_SD_GATT_TABLE_START + MICROBIT_SD_GATT_TABLE_SIZE, MICROBIT_SD_LIMIT);
ikkeje 0:ee31ccbe9919 163 #else
ikkeje 0:ee31ccbe9919 164 microbit_create_heap(MICROBIT_SRAM_BASE, MICROBIT_SD_LIMIT);
ikkeje 0:ee31ccbe9919 165 #endif
ikkeje 0:ee31ccbe9919 166 #endif
ikkeje 0:ee31ccbe9919 167
ikkeje 0:ee31ccbe9919 168 #if CONFIG_ENABLED(MICROBIT_BLE_ENABLED)
ikkeje 0:ee31ccbe9919 169 // Start the BLE stack, if it isn't already running.
ikkeje 0:ee31ccbe9919 170 if (!ble)
ikkeje 0:ee31ccbe9919 171 {
ikkeje 0:ee31ccbe9919 172 bleManager.init(getName(), getSerial(), messageBus, false);
ikkeje 0:ee31ccbe9919 173 ble = bleManager.ble;
ikkeje 0:ee31ccbe9919 174 }
ikkeje 0:ee31ccbe9919 175 #endif
ikkeje 0:ee31ccbe9919 176 }
ikkeje 0:ee31ccbe9919 177
ikkeje 0:ee31ccbe9919 178 /**
ikkeje 0:ee31ccbe9919 179 * A listener to perform actions as a result of Message Bus reflection.
ikkeje 0:ee31ccbe9919 180 *
ikkeje 0:ee31ccbe9919 181 * In some cases we want to perform lazy instantiation of components, such as
ikkeje 0:ee31ccbe9919 182 * the compass and the accelerometer, where we only want to add them to the idle
ikkeje 0:ee31ccbe9919 183 * fiber when someone has the intention of using these components.
ikkeje 0:ee31ccbe9919 184 */
ikkeje 0:ee31ccbe9919 185 void MicroBit::onListenerRegisteredEvent(MicroBitEvent evt)
ikkeje 0:ee31ccbe9919 186 {
ikkeje 0:ee31ccbe9919 187 switch(evt.value)
ikkeje 0:ee31ccbe9919 188 {
ikkeje 0:ee31ccbe9919 189 case MICROBIT_ID_BUTTON_AB:
ikkeje 0:ee31ccbe9919 190 // A user has registered to receive events from the buttonAB multibutton.
ikkeje 0:ee31ccbe9919 191 // Disable click events from being generated by ButtonA and ButtonB, and defer the
ikkeje 0:ee31ccbe9919 192 // control of this to the multibutton handler.
ikkeje 0:ee31ccbe9919 193 //
ikkeje 0:ee31ccbe9919 194 // This way, buttons look independent unless a buttonAB is requested, at which
ikkeje 0:ee31ccbe9919 195 // point button A+B clicks can be correclty handled without breaking
ikkeje 0:ee31ccbe9919 196 // causal ordering.
ikkeje 0:ee31ccbe9919 197 buttonA.setEventConfiguration(MICROBIT_BUTTON_SIMPLE_EVENTS);
ikkeje 0:ee31ccbe9919 198 buttonB.setEventConfiguration(MICROBIT_BUTTON_SIMPLE_EVENTS);
ikkeje 0:ee31ccbe9919 199 buttonAB.setEventConfiguration(MICROBIT_BUTTON_ALL_EVENTS);
ikkeje 0:ee31ccbe9919 200 break;
ikkeje 0:ee31ccbe9919 201
ikkeje 0:ee31ccbe9919 202 case MICROBIT_ID_COMPASS:
ikkeje 0:ee31ccbe9919 203 // A listener has been registered for the compass.
ikkeje 0:ee31ccbe9919 204 // The compass uses lazy instantiation, we just need to read the data once to start it running.
ikkeje 0:ee31ccbe9919 205 // Touch the compass through the heading() function to ensure it is calibrated. if it isn't this will launch any associated calibration algorithms.
ikkeje 0:ee31ccbe9919 206 compass.heading();
ikkeje 0:ee31ccbe9919 207
ikkeje 0:ee31ccbe9919 208 break;
ikkeje 0:ee31ccbe9919 209
ikkeje 0:ee31ccbe9919 210 case MICROBIT_ID_ACCELEROMETER:
ikkeje 0:ee31ccbe9919 211 case MICROBIT_ID_GESTURE:
ikkeje 0:ee31ccbe9919 212 // A listener has been registered for the accelerometer.
ikkeje 0:ee31ccbe9919 213 // The accelerometer uses lazy instantiation, we just need to read the data once to start it running.
ikkeje 0:ee31ccbe9919 214 accelerometer.updateSample();
ikkeje 0:ee31ccbe9919 215 break;
ikkeje 0:ee31ccbe9919 216
ikkeje 0:ee31ccbe9919 217 case MICROBIT_ID_THERMOMETER:
ikkeje 0:ee31ccbe9919 218 // A listener has been registered for the thermometer.
ikkeje 0:ee31ccbe9919 219 // The thermometer uses lazy instantiation, we just need to read the data once to start it running.
ikkeje 0:ee31ccbe9919 220 thermometer.updateSample();
ikkeje 0:ee31ccbe9919 221 break;
ikkeje 0:ee31ccbe9919 222 }
ikkeje 0:ee31ccbe9919 223 }