Eddystone test using modified DAL
Dependencies: BLE_API mbed-dev-bin nRF51822
Dependents: microbit-eddystone
Fork of microbit-dal by
inc/types/MicroBitEvent.h@37:b624ae5e94a5, 2016-07-13 (annotated)
- Committer:
- LancasterUniversity
- Date:
- Wed Jul 13 12:18:16 2016 +0100
- Revision:
- 37:b624ae5e94a5
- Parent:
- 35:8ce23bc1af38
- Child:
- 49:88f03f3feff1
Synchronized with git rev 7443b783
Author: Joe Finney
Fix typos
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Jonathan Austin |
1:8aa5cdb4ab67 | 1 | /* |
Jonathan Austin |
1:8aa5cdb4ab67 | 2 | The MIT License (MIT) |
Jonathan Austin |
1:8aa5cdb4ab67 | 3 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 4 | Copyright (c) 2016 British Broadcasting Corporation. |
Jonathan Austin |
1:8aa5cdb4ab67 | 5 | This software is provided by Lancaster University by arrangement with the BBC. |
Jonathan Austin |
1:8aa5cdb4ab67 | 6 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 7 | Permission is hereby granted, free of charge, to any person obtaining a |
Jonathan Austin |
1:8aa5cdb4ab67 | 8 | copy of this software and associated documentation files (the "Software"), |
Jonathan Austin |
1:8aa5cdb4ab67 | 9 | to deal in the Software without restriction, including without limitation |
Jonathan Austin |
1:8aa5cdb4ab67 | 10 | the rights to use, copy, modify, merge, publish, distribute, sublicense, |
Jonathan Austin |
1:8aa5cdb4ab67 | 11 | and/or sell copies of the Software, and to permit persons to whom the |
Jonathan Austin |
1:8aa5cdb4ab67 | 12 | Software is furnished to do so, subject to the following conditions: |
Jonathan Austin |
1:8aa5cdb4ab67 | 13 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 14 | The above copyright notice and this permission notice shall be included in |
Jonathan Austin |
1:8aa5cdb4ab67 | 15 | all copies or substantial portions of the Software. |
Jonathan Austin |
1:8aa5cdb4ab67 | 16 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 17 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
Jonathan Austin |
1:8aa5cdb4ab67 | 18 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
Jonathan Austin |
1:8aa5cdb4ab67 | 19 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
Jonathan Austin |
1:8aa5cdb4ab67 | 20 | THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
Jonathan Austin |
1:8aa5cdb4ab67 | 21 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
Jonathan Austin |
1:8aa5cdb4ab67 | 22 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
Jonathan Austin |
1:8aa5cdb4ab67 | 23 | DEALINGS IN THE SOFTWARE. |
Jonathan Austin |
1:8aa5cdb4ab67 | 24 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 25 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 26 | #ifndef MICROBIT_EVENT_H |
Jonathan Austin |
1:8aa5cdb4ab67 | 27 | #define MICROBIT_EVENT_H |
Jonathan Austin |
1:8aa5cdb4ab67 | 28 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 29 | #include "mbed.h" |
Jonathan Austin |
1:8aa5cdb4ab67 | 30 | #include "MicroBitConfig.h" |
Jonathan Austin |
1:8aa5cdb4ab67 | 31 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 32 | // Wildcard event codes |
Jonathan Austin |
1:8aa5cdb4ab67 | 33 | #define MICROBIT_ID_ANY 0 |
Jonathan Austin |
1:8aa5cdb4ab67 | 34 | #define MICROBIT_EVT_ANY 0 |
Jonathan Austin |
1:8aa5cdb4ab67 | 35 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 36 | enum MicroBitEventLaunchMode |
Jonathan Austin |
1:8aa5cdb4ab67 | 37 | { |
Jonathan Austin |
1:8aa5cdb4ab67 | 38 | CREATE_ONLY, |
Jonathan Austin |
1:8aa5cdb4ab67 | 39 | CREATE_AND_FIRE |
Jonathan Austin |
1:8aa5cdb4ab67 | 40 | }; |
Jonathan Austin |
1:8aa5cdb4ab67 | 41 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 42 | #define MICROBIT_EVENT_DEFAULT_LAUNCH_MODE CREATE_AND_FIRE |
Jonathan Austin |
1:8aa5cdb4ab67 | 43 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 44 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 45 | * Class definition for a MicroBitEvent |
Jonathan Austin |
1:8aa5cdb4ab67 | 46 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 47 | * It represents a common event that is generated by the various components on the micro:bit. |
Jonathan Austin |
1:8aa5cdb4ab67 | 48 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 49 | class MicroBitEvent |
Jonathan Austin |
1:8aa5cdb4ab67 | 50 | { |
Jonathan Austin |
1:8aa5cdb4ab67 | 51 | public: |
Jonathan Austin |
1:8aa5cdb4ab67 | 52 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 53 | uint16_t source; // ID of the MicroBit Component that generated the event e.g. MICROBIT_ID_BUTTON_A. |
Jonathan Austin |
1:8aa5cdb4ab67 | 54 | uint16_t value; // Component specific code indicating the cause of the event. |
LancasterUniversity | 37:b624ae5e94a5 | 55 | uint32_t timestamp; // Time at which the event was generated. ms since power on. |
Jonathan Austin |
1:8aa5cdb4ab67 | 56 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 57 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 58 | * Constructor. |
Jonathan Austin |
1:8aa5cdb4ab67 | 59 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 60 | * @param src The id of the MicroBit Component that generated the event e.g. MICROBIT_ID_BUTTON_A. |
Jonathan Austin |
1:8aa5cdb4ab67 | 61 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 62 | * @param value A component specific code indicating the cause of the event. |
Jonathan Austin |
1:8aa5cdb4ab67 | 63 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 64 | * @param mode Optional definition of how the event should be processed after construction (if at all): |
Jonathan Austin |
1:8aa5cdb4ab67 | 65 | * CREATE_ONLY: MicroBitEvent is initialised, and no further processing takes place. |
Jonathan Austin |
1:8aa5cdb4ab67 | 66 | * CREATE_AND_FIRE: MicroBitEvent is initialised, and its event handlers are immediately fired (not suitable for use in interrupts!). |
Jonathan Austin |
1:8aa5cdb4ab67 | 67 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 68 | * @code |
Jonathan Austin |
1:8aa5cdb4ab67 | 69 | * // Create and launch an event using the default configuration |
Jonathan Austin |
1:8aa5cdb4ab67 | 70 | * MicrobitEvent evt(id,MICROBIT_BUTTON_EVT_CLICK); |
Jonathan Austin |
1:8aa5cdb4ab67 | 71 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 72 | * // Create an event only, do not fire onto an EventModel. |
Jonathan Austin |
1:8aa5cdb4ab67 | 73 | * MicrobitEvent evt(id,MICROBIT_BUTTON_EVT_CLICK,CREATE_AND_FIRE); |
Jonathan Austin |
1:8aa5cdb4ab67 | 74 | * @endcode |
Jonathan Austin |
1:8aa5cdb4ab67 | 75 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 76 | MicroBitEvent(uint16_t source, uint16_t value, MicroBitEventLaunchMode mode = MICROBIT_EVENT_DEFAULT_LAUNCH_MODE); |
Jonathan Austin |
1:8aa5cdb4ab67 | 77 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 78 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 79 | * Default constructor - initialises all values, and sets timestamp to the current time. |
Jonathan Austin |
1:8aa5cdb4ab67 | 80 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 81 | MicroBitEvent(); |
Jonathan Austin |
1:8aa5cdb4ab67 | 82 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 83 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 84 | * Fires this MicroBitEvent onto the Default EventModel, or a custom one! |
Jonathan Austin |
1:8aa5cdb4ab67 | 85 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 86 | void fire(); |
Jonathan Austin |
1:8aa5cdb4ab67 | 87 | }; |
Jonathan Austin |
1:8aa5cdb4ab67 | 88 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 89 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 90 | * Enclosing class to hold a chain of events. |
Jonathan Austin |
1:8aa5cdb4ab67 | 91 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 92 | struct MicroBitEventQueueItem |
Jonathan Austin |
1:8aa5cdb4ab67 | 93 | { |
Jonathan Austin |
1:8aa5cdb4ab67 | 94 | MicroBitEvent evt; |
Jonathan Austin |
1:8aa5cdb4ab67 | 95 | MicroBitEventQueueItem *next; |
Jonathan Austin |
1:8aa5cdb4ab67 | 96 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 97 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 98 | * Constructor. |
Jonathan Austin |
1:8aa5cdb4ab67 | 99 | * Create a new MicroBitEventQueueItem. |
Jonathan Austin |
1:8aa5cdb4ab67 | 100 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 101 | * @param evt The event to be queued. |
Jonathan Austin |
1:8aa5cdb4ab67 | 102 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 103 | MicroBitEventQueueItem(MicroBitEvent evt); |
Jonathan Austin |
1:8aa5cdb4ab67 | 104 | }; |
Jonathan Austin |
1:8aa5cdb4ab67 | 105 | |
LancasterUniversity | 31:87789e55bac7 | 106 | #endif |