mbed-os
Dependents: cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more
hal/analogin_api.h@0:b74591d5ab33, 2017-12-11 (annotated)
- Committer:
- be_bryan
- Date:
- Mon Dec 11 17:54:04 2017 +0000
- Revision:
- 0:b74591d5ab33
motor ++
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
be_bryan | 0:b74591d5ab33 | 1 | |
be_bryan | 0:b74591d5ab33 | 2 | /** \addtogroup hal */ |
be_bryan | 0:b74591d5ab33 | 3 | /** @{*/ |
be_bryan | 0:b74591d5ab33 | 4 | /* mbed Microcontroller Library |
be_bryan | 0:b74591d5ab33 | 5 | * Copyright (c) 2006-2013 ARM Limited |
be_bryan | 0:b74591d5ab33 | 6 | * |
be_bryan | 0:b74591d5ab33 | 7 | * Licensed under the Apache License, Version 2.0 (the "License"); |
be_bryan | 0:b74591d5ab33 | 8 | * you may not use this file except in compliance with the License. |
be_bryan | 0:b74591d5ab33 | 9 | * You may obtain a copy of the License at |
be_bryan | 0:b74591d5ab33 | 10 | * |
be_bryan | 0:b74591d5ab33 | 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
be_bryan | 0:b74591d5ab33 | 12 | * |
be_bryan | 0:b74591d5ab33 | 13 | * Unless required by applicable law or agreed to in writing, software |
be_bryan | 0:b74591d5ab33 | 14 | * distributed under the License is distributed on an "AS IS" BASIS, |
be_bryan | 0:b74591d5ab33 | 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
be_bryan | 0:b74591d5ab33 | 16 | * See the License for the specific language governing permissions and |
be_bryan | 0:b74591d5ab33 | 17 | * limitations under the License. |
be_bryan | 0:b74591d5ab33 | 18 | */ |
be_bryan | 0:b74591d5ab33 | 19 | #ifndef MBED_ANALOGIN_API_H |
be_bryan | 0:b74591d5ab33 | 20 | #define MBED_ANALOGIN_API_H |
be_bryan | 0:b74591d5ab33 | 21 | |
be_bryan | 0:b74591d5ab33 | 22 | #include "device.h" |
be_bryan | 0:b74591d5ab33 | 23 | |
be_bryan | 0:b74591d5ab33 | 24 | #if DEVICE_ANALOGIN |
be_bryan | 0:b74591d5ab33 | 25 | |
be_bryan | 0:b74591d5ab33 | 26 | #ifdef __cplusplus |
be_bryan | 0:b74591d5ab33 | 27 | extern "C" { |
be_bryan | 0:b74591d5ab33 | 28 | #endif |
be_bryan | 0:b74591d5ab33 | 29 | |
be_bryan | 0:b74591d5ab33 | 30 | /** Analogin hal structure. analogin_s is declared in the target's hal |
be_bryan | 0:b74591d5ab33 | 31 | */ |
be_bryan | 0:b74591d5ab33 | 32 | typedef struct analogin_s analogin_t; |
be_bryan | 0:b74591d5ab33 | 33 | |
be_bryan | 0:b74591d5ab33 | 34 | /** |
be_bryan | 0:b74591d5ab33 | 35 | * \defgroup hal_analogin Analogin hal functions |
be_bryan | 0:b74591d5ab33 | 36 | * @{ |
be_bryan | 0:b74591d5ab33 | 37 | */ |
be_bryan | 0:b74591d5ab33 | 38 | |
be_bryan | 0:b74591d5ab33 | 39 | /** Initialize the analogin peripheral |
be_bryan | 0:b74591d5ab33 | 40 | * |
be_bryan | 0:b74591d5ab33 | 41 | * Configures the pin used by analogin. |
be_bryan | 0:b74591d5ab33 | 42 | * @param obj The analogin object to initialize |
be_bryan | 0:b74591d5ab33 | 43 | * @param pin The analogin pin name |
be_bryan | 0:b74591d5ab33 | 44 | */ |
be_bryan | 0:b74591d5ab33 | 45 | void analogin_init(analogin_t *obj, PinName pin); |
be_bryan | 0:b74591d5ab33 | 46 | |
be_bryan | 0:b74591d5ab33 | 47 | /** Read the input voltage, represented as a float in the range [0.0, 1.0] |
be_bryan | 0:b74591d5ab33 | 48 | * |
be_bryan | 0:b74591d5ab33 | 49 | * @param obj The analogin object |
be_bryan | 0:b74591d5ab33 | 50 | * @return A floating value representing the current input voltage |
be_bryan | 0:b74591d5ab33 | 51 | */ |
be_bryan | 0:b74591d5ab33 | 52 | float analogin_read(analogin_t *obj); |
be_bryan | 0:b74591d5ab33 | 53 | |
be_bryan | 0:b74591d5ab33 | 54 | /** Read the value from analogin pin, represented as an unsigned 16bit value |
be_bryan | 0:b74591d5ab33 | 55 | * |
be_bryan | 0:b74591d5ab33 | 56 | * @param obj The analogin object |
be_bryan | 0:b74591d5ab33 | 57 | * @return An unsigned 16bit value representing the current input voltage |
be_bryan | 0:b74591d5ab33 | 58 | */ |
be_bryan | 0:b74591d5ab33 | 59 | uint16_t analogin_read_u16(analogin_t *obj); |
be_bryan | 0:b74591d5ab33 | 60 | |
be_bryan | 0:b74591d5ab33 | 61 | /**@}*/ |
be_bryan | 0:b74591d5ab33 | 62 | |
be_bryan | 0:b74591d5ab33 | 63 | #ifdef __cplusplus |
be_bryan | 0:b74591d5ab33 | 64 | } |
be_bryan | 0:b74591d5ab33 | 65 | #endif |
be_bryan | 0:b74591d5ab33 | 66 | |
be_bryan | 0:b74591d5ab33 | 67 | #endif |
be_bryan | 0:b74591d5ab33 | 68 | |
be_bryan | 0:b74591d5ab33 | 69 | #endif |
be_bryan | 0:b74591d5ab33 | 70 | |
be_bryan | 0:b74591d5ab33 | 71 | /** @}*/ |