PES4 / Mbed OS Queue_02

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/hal/analogin_api.h@1:b36bbc1c6d27, 2020-04-11 (annotated)

Committer:
demayer
Date:
Sat Apr 11 08:15:48 2020 +0000
Revision:
1:b36bbc1c6d27
Parent:
0:6bf0743ece18 
IMU-library in .h und .cpp file aufgeteilt

Who changed what in which revision?

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