George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

mbed/mbed_interface.h@0:dd0fea342ad2, 2015-03-08 (annotated)

Committer:
gkroussos
Date:
Sun Mar 08 19:42:20 2015 +0000
Revision:
0:dd0fea342ad2
BLE Temperature Service ; Mobile and Ubiquitous Computing Module; Birkbeck College

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gkroussos 0:dd0fea342ad2 1 /* mbed Microcontroller Library
gkroussos 0:dd0fea342ad2 2 * Copyright (c) 2006-2013 ARM Limited
gkroussos 0:dd0fea342ad2 3 *
gkroussos 0:dd0fea342ad2 4 * Licensed under the Apache License, Version 2.0 (the "License");
gkroussos 0:dd0fea342ad2 5 * you may not use this file except in compliance with the License.
gkroussos 0:dd0fea342ad2 6 * You may obtain a copy of the License at
gkroussos 0:dd0fea342ad2 7 *
gkroussos 0:dd0fea342ad2 8 * http://www.apache.org/licenses/LICENSE-2.0
gkroussos 0:dd0fea342ad2 9 *
gkroussos 0:dd0fea342ad2 10 * Unless required by applicable law or agreed to in writing, software
gkroussos 0:dd0fea342ad2 11 * distributed under the License is distributed on an "AS IS" BASIS,
gkroussos 0:dd0fea342ad2 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
gkroussos 0:dd0fea342ad2 13 * See the License for the specific language governing permissions and
gkroussos 0:dd0fea342ad2 14 * limitations under the License.
gkroussos 0:dd0fea342ad2 15 */
gkroussos 0:dd0fea342ad2 16 #ifndef MBED_INTERFACE_H
gkroussos 0:dd0fea342ad2 17 #define MBED_INTERFACE_H
gkroussos 0:dd0fea342ad2 18
gkroussos 0:dd0fea342ad2 19 #include "device.h"
gkroussos 0:dd0fea342ad2 20
gkroussos 0:dd0fea342ad2 21 /* Mbed interface mac address
gkroussos 0:dd0fea342ad2 22 * if MBED_MAC_ADD_x are zero, interface uid sets mac address,
gkroussos 0:dd0fea342ad2 23 * otherwise MAC_ADD_x are used.
gkroussos 0:dd0fea342ad2 24 */
gkroussos 0:dd0fea342ad2 25 #define MBED_MAC_ADDR_INTERFACE 0x00
gkroussos 0:dd0fea342ad2 26 #define MBED_MAC_ADDR_0 MBED_MAC_ADDR_INTERFACE
gkroussos 0:dd0fea342ad2 27 #define MBED_MAC_ADDR_1 MBED_MAC_ADDR_INTERFACE
gkroussos 0:dd0fea342ad2 28 #define MBED_MAC_ADDR_2 MBED_MAC_ADDR_INTERFACE
gkroussos 0:dd0fea342ad2 29 #define MBED_MAC_ADDR_3 MBED_MAC_ADDR_INTERFACE
gkroussos 0:dd0fea342ad2 30 #define MBED_MAC_ADDR_4 MBED_MAC_ADDR_INTERFACE
gkroussos 0:dd0fea342ad2 31 #define MBED_MAC_ADDR_5 MBED_MAC_ADDR_INTERFACE
gkroussos 0:dd0fea342ad2 32 #define MBED_MAC_ADDRESS_SUM (MBED_MAC_ADDR_0 | MBED_MAC_ADDR_1 | MBED_MAC_ADDR_2 | MBED_MAC_ADDR_3 | MBED_MAC_ADDR_4 | MBED_MAC_ADDR_5)
gkroussos 0:dd0fea342ad2 33
gkroussos 0:dd0fea342ad2 34 #ifdef __cplusplus
gkroussos 0:dd0fea342ad2 35 extern "C" {
gkroussos 0:dd0fea342ad2 36 #endif
gkroussos 0:dd0fea342ad2 37
gkroussos 0:dd0fea342ad2 38 #if DEVICE_SEMIHOST
gkroussos 0:dd0fea342ad2 39
gkroussos 0:dd0fea342ad2 40 /** Functions to control the mbed interface
gkroussos 0:dd0fea342ad2 41 *
gkroussos 0:dd0fea342ad2 42 * mbed Microcontrollers have a built-in interface to provide functionality such as
gkroussos 0:dd0fea342ad2 43 * drag-n-drop download, reset, serial-over-usb, and access to the mbed local file
gkroussos 0:dd0fea342ad2 44 * system. These functions provide means to control the interface suing semihost
gkroussos 0:dd0fea342ad2 45 * calls it supports.
gkroussos 0:dd0fea342ad2 46 */
gkroussos 0:dd0fea342ad2 47
gkroussos 0:dd0fea342ad2 48 /** Determine whether the mbed interface is connected, based on whether debug is enabled
gkroussos 0:dd0fea342ad2 49 *
gkroussos 0:dd0fea342ad2 50 * @returns
gkroussos 0:dd0fea342ad2 51 * 1 if interface is connected,
gkroussos 0:dd0fea342ad2 52 * 0 otherwise
gkroussos 0:dd0fea342ad2 53 */
gkroussos 0:dd0fea342ad2 54 int mbed_interface_connected(void);
gkroussos 0:dd0fea342ad2 55
gkroussos 0:dd0fea342ad2 56 /** Instruct the mbed interface to reset, as if the reset button had been pressed
gkroussos 0:dd0fea342ad2 57 *
gkroussos 0:dd0fea342ad2 58 * @returns
gkroussos 0:dd0fea342ad2 59 * 1 if successful,
gkroussos 0:dd0fea342ad2 60 * 0 otherwise (e.g. interface not present)
gkroussos 0:dd0fea342ad2 61 */
gkroussos 0:dd0fea342ad2 62 int mbed_interface_reset(void);
gkroussos 0:dd0fea342ad2 63
gkroussos 0:dd0fea342ad2 64 /** This will disconnect the debug aspect of the interface, so semihosting will be disabled.
gkroussos 0:dd0fea342ad2 65 * The interface will still support the USB serial aspect
gkroussos 0:dd0fea342ad2 66 *
gkroussos 0:dd0fea342ad2 67 * @returns
gkroussos 0:dd0fea342ad2 68 * 0 if successful,
gkroussos 0:dd0fea342ad2 69 * -1 otherwise (e.g. interface not present)
gkroussos 0:dd0fea342ad2 70 */
gkroussos 0:dd0fea342ad2 71 int mbed_interface_disconnect(void);
gkroussos 0:dd0fea342ad2 72
gkroussos 0:dd0fea342ad2 73 /** This will disconnect the debug aspect of the interface, and if the USB cable is not
gkroussos 0:dd0fea342ad2 74 * connected, also power down the interface. If the USB cable is connected, the interface
gkroussos 0:dd0fea342ad2 75 * will remain powered up and visible to the host
gkroussos 0:dd0fea342ad2 76 *
gkroussos 0:dd0fea342ad2 77 * @returns
gkroussos 0:dd0fea342ad2 78 * 0 if successful,
gkroussos 0:dd0fea342ad2 79 * -1 otherwise (e.g. interface not present)
gkroussos 0:dd0fea342ad2 80 */
gkroussos 0:dd0fea342ad2 81 int mbed_interface_powerdown(void);
gkroussos 0:dd0fea342ad2 82
gkroussos 0:dd0fea342ad2 83 /** This returns a string containing the 32-character UID of the mbed interface
gkroussos 0:dd0fea342ad2 84 * This is a weak function that can be overwritten if required
gkroussos 0:dd0fea342ad2 85 *
gkroussos 0:dd0fea342ad2 86 * @param uid A 33-byte array to write the null terminated 32-byte string
gkroussos 0:dd0fea342ad2 87 *
gkroussos 0:dd0fea342ad2 88 * @returns
gkroussos 0:dd0fea342ad2 89 * 0 if successful,
gkroussos 0:dd0fea342ad2 90 * -1 otherwise (e.g. interface not present)
gkroussos 0:dd0fea342ad2 91 */
gkroussos 0:dd0fea342ad2 92 int mbed_interface_uid(char *uid);
gkroussos 0:dd0fea342ad2 93
gkroussos 0:dd0fea342ad2 94 #endif
gkroussos 0:dd0fea342ad2 95
gkroussos 0:dd0fea342ad2 96 /** This returns a unique 6-byte MAC address, based on the interface UID
gkroussos 0:dd0fea342ad2 97 * If the interface is not present, it returns a default fixed MAC address (00:02:F7:F0:00:00)
gkroussos 0:dd0fea342ad2 98 *
gkroussos 0:dd0fea342ad2 99 * This is a weak function that can be overwritten if you want to provide your own mechanism to
gkroussos 0:dd0fea342ad2 100 * provide a MAC address.
gkroussos 0:dd0fea342ad2 101 *
gkroussos 0:dd0fea342ad2 102 * @param mac A 6-byte array to write the MAC address
gkroussos 0:dd0fea342ad2 103 */
gkroussos 0:dd0fea342ad2 104 void mbed_mac_address(char *mac);
gkroussos 0:dd0fea342ad2 105
gkroussos 0:dd0fea342ad2 106 /** Cause the mbed to flash the BLOD (Blue LEDs Of Death) sequence
gkroussos 0:dd0fea342ad2 107 */
gkroussos 0:dd0fea342ad2 108 void mbed_die(void);
gkroussos 0:dd0fea342ad2 109
gkroussos 0:dd0fea342ad2 110 #ifdef __cplusplus
gkroussos 0:dd0fea342ad2 111 }
gkroussos 0:dd0fea342ad2 112 #endif
gkroussos 0:dd0fea342ad2 113
gkroussos 0:dd0fea342ad2 114 #endif