Essai d'application Lycée Malraux NSI
Dependencies: BLE_API nRF51822 mbed-dev-bin
inc/drivers/MicroBitRadioDatagram.h@1:8aa5cdb4ab67, 2016-04-07 (annotated)
- Committer:
- Jonathan Austin
- Date:
- Thu Apr 07 01:33:22 2016 +0100
- Revision:
- 1:8aa5cdb4ab67
Synchronized with git rev 55cb9199
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_RADIO_DATAGRAM_H |
Jonathan Austin |
1:8aa5cdb4ab67 | 27 | #define MICROBIT_RADIO_DATAGRAM_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 | #include "MicroBitRadio.h" |
Jonathan Austin |
1:8aa5cdb4ab67 | 32 | #include "ManagedString.h" |
Jonathan Austin |
1:8aa5cdb4ab67 | 33 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 34 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 35 | * Provides a simple broadcast radio abstraction, built upon the raw nrf51822 RADIO module. |
Jonathan Austin |
1:8aa5cdb4ab67 | 36 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 37 | * This class provides the ability to broadcast simple text or binary messages to other micro:bits in the vicinity |
Jonathan Austin |
1:8aa5cdb4ab67 | 38 | * It is envisaged that this would provide the basis for children to experiment with building their own, simple, |
Jonathan Austin |
1:8aa5cdb4ab67 | 39 | * custom protocols. |
Jonathan Austin |
1:8aa5cdb4ab67 | 40 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 41 | * @note This API does not contain any form of encryption, authentication or authorisation. Its purpose is solely for use as a |
Jonathan Austin |
1:8aa5cdb4ab67 | 42 | * teaching aid to demonstrate how simple communications operates, and to provide a sandpit through which learning can take place. |
Jonathan Austin |
1:8aa5cdb4ab67 | 43 | * For serious applications, BLE should be considered a substantially more secure alternative. |
Jonathan Austin |
1:8aa5cdb4ab67 | 44 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 45 | class MicroBitRadioDatagram |
Jonathan Austin |
1:8aa5cdb4ab67 | 46 | { |
Jonathan Austin |
1:8aa5cdb4ab67 | 47 | MicroBitRadio &radio; // The underlying radio module used to send and receive data. |
Jonathan Austin |
1:8aa5cdb4ab67 | 48 | FrameBuffer *rxQueue; // A linear list of incoming packets, queued awaiting processing. |
Jonathan Austin |
1:8aa5cdb4ab67 | 49 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 50 | public: |
Jonathan Austin |
1:8aa5cdb4ab67 | 51 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 52 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 53 | * Constructor. |
Jonathan Austin |
1:8aa5cdb4ab67 | 54 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 55 | * Creates an instance of a MicroBitRadioDatagram which offers the ability |
Jonathan Austin |
1:8aa5cdb4ab67 | 56 | * to broadcast simple text or binary messages to other micro:bits in the vicinity |
Jonathan Austin |
1:8aa5cdb4ab67 | 57 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 58 | * @param r The underlying radio module used to send and receive data. |
Jonathan Austin |
1:8aa5cdb4ab67 | 59 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 60 | MicroBitRadioDatagram(MicroBitRadio &r); |
Jonathan Austin |
1:8aa5cdb4ab67 | 61 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 62 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 63 | * Retrieves packet payload data into the given buffer. |
Jonathan Austin |
1:8aa5cdb4ab67 | 64 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 65 | * If a data packet is already available, then it will be returned immediately to the caller. |
Jonathan Austin |
1:8aa5cdb4ab67 | 66 | * If no data is available then MICROBIT_INVALID_PARAMETER is returned. |
Jonathan Austin |
1:8aa5cdb4ab67 | 67 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 68 | * @param buf A pointer to a valid memory location where the received data is to be stored |
Jonathan Austin |
1:8aa5cdb4ab67 | 69 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 70 | * @param len The maximum amount of data that can safely be stored in 'buf' |
Jonathan Austin |
1:8aa5cdb4ab67 | 71 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 72 | * @return The length of the data stored, or MICROBIT_INVALID_PARAMETER if no data is available, or the memory regions provided are invalid. |
Jonathan Austin |
1:8aa5cdb4ab67 | 73 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 74 | int recv(uint8_t *buf, int len); |
Jonathan Austin |
1:8aa5cdb4ab67 | 75 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 76 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 77 | * Retreives packet payload data into the given buffer. |
Jonathan Austin |
1:8aa5cdb4ab67 | 78 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 79 | * If a data packet is already available, then it will be returned immediately to the caller |
Jonathan Austin |
1:8aa5cdb4ab67 | 80 | * in the form of a PacketBuffer. |
Jonathan Austin |
1:8aa5cdb4ab67 | 81 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 82 | * @return the data received, or an empty PacketBuffer if no data is available. |
Jonathan Austin |
1:8aa5cdb4ab67 | 83 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 84 | PacketBuffer recv(); |
Jonathan Austin |
1:8aa5cdb4ab67 | 85 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 86 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 87 | * Transmits the given buffer onto the broadcast radio. |
Jonathan Austin |
1:8aa5cdb4ab67 | 88 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 89 | * This is a synchronous call that will wait until the transmission of the packet |
Jonathan Austin |
1:8aa5cdb4ab67 | 90 | * has completed before returning. |
Jonathan Austin |
1:8aa5cdb4ab67 | 91 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 92 | * @param buffer The packet contents to transmit. |
Jonathan Austin |
1:8aa5cdb4ab67 | 93 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 94 | * @param len The number of bytes to transmit. |
Jonathan Austin |
1:8aa5cdb4ab67 | 95 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 96 | * @return MICROBIT_OK on success, or MICROBIT_INVALID_PARAMETER if the buffer is invalid, |
Jonathan Austin |
1:8aa5cdb4ab67 | 97 | * or the number of bytes to transmit is greater than `MICROBIT_RADIO_MAX_PACKET_SIZE + MICROBIT_RADIO_HEADER_SIZE`. |
Jonathan Austin |
1:8aa5cdb4ab67 | 98 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 99 | int send(uint8_t *buffer, int len); |
Jonathan Austin |
1:8aa5cdb4ab67 | 100 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 101 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 102 | * Transmits the given string onto the broadcast radio. |
Jonathan Austin |
1:8aa5cdb4ab67 | 103 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 104 | * This is a synchronous call that will wait until the transmission of the packet |
Jonathan Austin |
1:8aa5cdb4ab67 | 105 | * has completed before returning. |
Jonathan Austin |
1:8aa5cdb4ab67 | 106 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 107 | * @param data The packet contents to transmit. |
Jonathan Austin |
1:8aa5cdb4ab67 | 108 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 109 | * @return MICROBIT_OK on success, or MICROBIT_INVALID_PARAMETER if the buffer is invalid, |
Jonathan Austin |
1:8aa5cdb4ab67 | 110 | * or the number of bytes to transmit is greater than `MICROBIT_RADIO_MAX_PACKET_SIZE + MICROBIT_RADIO_HEADER_SIZE`. |
Jonathan Austin |
1:8aa5cdb4ab67 | 111 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 112 | int send(PacketBuffer data); |
Jonathan Austin |
1:8aa5cdb4ab67 | 113 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 114 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 115 | * Transmits the given string onto the broadcast radio. |
Jonathan Austin |
1:8aa5cdb4ab67 | 116 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 117 | * This is a synchronous call that will wait until the transmission of the packet |
Jonathan Austin |
1:8aa5cdb4ab67 | 118 | * has completed before returning. |
Jonathan Austin |
1:8aa5cdb4ab67 | 119 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 120 | * @param data The packet contents to transmit. |
Jonathan Austin |
1:8aa5cdb4ab67 | 121 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 122 | * @return MICROBIT_OK on success, or MICROBIT_INVALID_PARAMETER if the buffer is invalid, |
Jonathan Austin |
1:8aa5cdb4ab67 | 123 | * or the number of bytes to transmit is greater than `MICROBIT_RADIO_MAX_PACKET_SIZE + MICROBIT_RADIO_HEADER_SIZE`. |
Jonathan Austin |
1:8aa5cdb4ab67 | 124 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 125 | int send(ManagedString data); |
Jonathan Austin |
1:8aa5cdb4ab67 | 126 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 127 | /** |
Jonathan Austin |
1:8aa5cdb4ab67 | 128 | * Protocol handler callback. This is called when the radio receives a packet marked as a datagram. |
Jonathan Austin |
1:8aa5cdb4ab67 | 129 | * |
Jonathan Austin |
1:8aa5cdb4ab67 | 130 | * This function process this packet, and queues it for user reception. |
Jonathan Austin |
1:8aa5cdb4ab67 | 131 | */ |
Jonathan Austin |
1:8aa5cdb4ab67 | 132 | void packetReceived(); |
Jonathan Austin |
1:8aa5cdb4ab67 | 133 | }; |
Jonathan Austin |
1:8aa5cdb4ab67 | 134 | |
Jonathan Austin |
1:8aa5cdb4ab67 | 135 | #endif |