Revised to disable BLE for radio communication as needed.
Dependencies: BLE_API nRF51822 mbed-dev-bin
Diff: inc/core/MicroBitComponent.h
- Revision:
- 1:8aa5cdb4ab67
- Child:
- 41:da05ec75cd5d
diff -r fb15f7887843 -r 8aa5cdb4ab67 inc/core/MicroBitComponent.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/inc/core/MicroBitComponent.h Thu Apr 07 01:33:22 2016 +0100 @@ -0,0 +1,152 @@ +/* +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. +*/ + +#ifndef MICROBIT_COMPONENT_H +#define MICROBIT_COMPONENT_H + +#include "MicroBitConfig.h" + +// Enumeration of core components. +#define MICROBIT_ID_BUTTON_A 1 +#define MICROBIT_ID_BUTTON_B 2 +#define MICROBIT_ID_BUTTON_RESET 3 +#define MICROBIT_ID_ACCELEROMETER 4 +#define MICROBIT_ID_COMPASS 5 +#define MICROBIT_ID_DISPLAY 6 + +//EDGE connector events +#define MICROBIT_IO_PINS 20 + +#define MICROBIT_ID_IO_P0 7 //P0 is the left most pad (ANALOG/DIGITAL) +#define MICROBIT_ID_IO_P1 8 //P1 is the middle pad (ANALOG/DIGITAL) +#define MICROBIT_ID_IO_P2 9 //P2 is the right most pad (ANALOG/DIGITAL) +#define MICROBIT_ID_IO_P3 10 //COL1 (ANALOG/DIGITAL) +#define MICROBIT_ID_IO_P4 11 //BTN_A +#define MICROBIT_ID_IO_P5 12 //COL2 (ANALOG/DIGITAL) +#define MICROBIT_ID_IO_P6 13 //ROW2 +#define MICROBIT_ID_IO_P7 14 //ROW1 +#define MICROBIT_ID_IO_P8 15 //PIN 18 +#define MICROBIT_ID_IO_P9 16 //ROW3 +#define MICROBIT_ID_IO_P10 17 //COL3 (ANALOG/DIGITAL) +#define MICROBIT_ID_IO_P11 18 //BTN_B +#define MICROBIT_ID_IO_P12 19 //PIN 20 +#define MICROBIT_ID_IO_P13 20 //SCK +#define MICROBIT_ID_IO_P14 21 //MISO +#define MICROBIT_ID_IO_P15 22 //MOSI +#define MICROBIT_ID_IO_P16 23 //PIN 16 +#define MICROBIT_ID_IO_P19 24 //SCL +#define MICROBIT_ID_IO_P20 25 //SDA + +#define MICROBIT_ID_BUTTON_AB 26 // Button A+B multibutton +#define MICROBIT_ID_GESTURE 27 // Gesture events + +#define MICROBIT_ID_THERMOMETER 28 +#define MICROBIT_ID_RADIO 29 +#define MICROBIT_ID_RADIO_DATA_READY 30 +#define MICROBIT_ID_MULTIBUTTON_ATTACH 31 +#define MICROBIT_ID_SERIAL 32 + +#define MICROBIT_ID_MESSAGE_BUS_LISTENER 1021 // Message bus indication that a handler for a given ID has been registered. +#define MICROBIT_ID_NOTIFY_ONE 1022 // Notfication channel, for general purpose synchronisation +#define MICROBIT_ID_NOTIFY 1023 // Notfication channel, for general purpose synchronisation + +// Universal flags used as part of the status field +#define MICROBIT_COMPONENT_RUNNING 0x01 + + +/** + * Class definition for MicroBitComponent. + * + * All components should inherit from this class. + * + * If a component requires regular updates, then you should add the component + * to the systemTick and idleTick queues. + * + * The system timer will call systemTick() once the component has been added to + * the array of system components using system_timer_add_component. This callback + * will be in interrupt context. + * + * The idle thread will call idleTick() once the component has been added to the array + * of idle components using fiber_add_idle_component. Updates are determined by + * the isIdleCallbackNeeded() member function. + */ +class MicroBitComponent +{ + protected: + + uint16_t id; // Event Bus ID + uint8_t status; // keeps track of various component state, and also indicates if data is ready. + + public: + + /** + * The default constructor of a MicroBitComponent + */ + MicroBitComponent() + { + this->id = 0; + this->status = 0; + } + + /** + * The system timer will call this member function once the component has been added to + * the array of system components using system_timer_add_component. This callback + * will be in interrupt context. + */ + virtual void systemTick(){ + + } + + /** + * The idle thread will call this member function once the component has been added to the array + * of idle components using fiber_add_idle_component. Updates are determined by + * the isIdleCallbackNeeded() member function. + */ + virtual void idleTick() + { + + } + + /** + * When added to the idleThreadComponents array, this function will be called to determine + * if and when data is ready. + * + * @note override this if you want to request to be scheduled as soon as possible. + */ + virtual int isIdleCallbackNeeded() + { + return 0; + } + + /** + * If you have added your component to the idle or system tick component arrays, + * you must remember to remove your component from them if your component is destructed. + */ + virtual ~MicroBitComponent() + { + } +}; + +#endif