Micah B / mbed

mbed

Dependents:   DHTSensor_Test K64F_eCompass_OneNET_JW

mbed_interface.h@0:2cc6bb4d7fea, 2015-02-25 (annotated)

Committer:
mbotkinl
Date:
Wed Feb 25 20:22:22 2015 +0000
Revision:
0:2cc6bb4d7fea
Working code to read Temperature and Humidity readings

Who changed what in which revision?

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