Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

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.

Dependencies:   mbed

mbed-os/hal/pwmout_api.h@10:46a4cf51ee38, 2018-03-02 (annotated)

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:16:49 2018 -0700
Revision:
10:46a4cf51ee38
Parent:
9:d58e77ebd769 
remove mbed-os

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Nathan Yonkee 9:d58e77ebd769 1
Nathan Yonkee 9:d58e77ebd769 2 /** \addtogroup hal */
Nathan Yonkee 9:d58e77ebd769 3 /** @{*/
Nathan Yonkee 9:d58e77ebd769 4 /* mbed Microcontroller Library
Nathan Yonkee 9:d58e77ebd769 5 * Copyright (c) 2006-2013 ARM Limited
Nathan Yonkee 9:d58e77ebd769 6 *
Nathan Yonkee 9:d58e77ebd769 7 * Licensed under the Apache License, Version 2.0 (the "License");
Nathan Yonkee 9:d58e77ebd769 8 * you may not use this file except in compliance with the License.
Nathan Yonkee 9:d58e77ebd769 9 * You may obtain a copy of the License at
Nathan Yonkee 9:d58e77ebd769 10 *
Nathan Yonkee 9:d58e77ebd769 11 * http://www.apache.org/licenses/LICENSE-2.0
Nathan Yonkee 9:d58e77ebd769 12 *
Nathan Yonkee 9:d58e77ebd769 13 * Unless required by applicable law or agreed to in writing, software
Nathan Yonkee 9:d58e77ebd769 14 * distributed under the License is distributed on an "AS IS" BASIS,
Nathan Yonkee 9:d58e77ebd769 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Nathan Yonkee 9:d58e77ebd769 16 * See the License for the specific language governing permissions and
Nathan Yonkee 9:d58e77ebd769 17 * limitations under the License.
Nathan Yonkee 9:d58e77ebd769 18 */
Nathan Yonkee 9:d58e77ebd769 19 #ifndef MBED_PWMOUT_API_H
Nathan Yonkee 9:d58e77ebd769 20 #define MBED_PWMOUT_API_H
Nathan Yonkee 9:d58e77ebd769 21
Nathan Yonkee 9:d58e77ebd769 22 #include "device.h"
Nathan Yonkee 9:d58e77ebd769 23
Nathan Yonkee 9:d58e77ebd769 24 #if DEVICE_PWMOUT
Nathan Yonkee 9:d58e77ebd769 25
Nathan Yonkee 9:d58e77ebd769 26 #ifdef __cplusplus
Nathan Yonkee 9:d58e77ebd769 27 extern "C" {
Nathan Yonkee 9:d58e77ebd769 28 #endif
Nathan Yonkee 9:d58e77ebd769 29
Nathan Yonkee 9:d58e77ebd769 30 /** Pwmout hal structure. pwmout_s is declared in the target's hal
Nathan Yonkee 9:d58e77ebd769 31 */
Nathan Yonkee 9:d58e77ebd769 32 typedef struct pwmout_s pwmout_t;
Nathan Yonkee 9:d58e77ebd769 33
Nathan Yonkee 9:d58e77ebd769 34 /**
Nathan Yonkee 9:d58e77ebd769 35 * \defgroup hal_pwmout Pwmout hal functions
Nathan Yonkee 9:d58e77ebd769 36 * @{
Nathan Yonkee 9:d58e77ebd769 37 */
Nathan Yonkee 9:d58e77ebd769 38
Nathan Yonkee 9:d58e77ebd769 39 /** Initialize the pwm out peripheral and configure the pin
Nathan Yonkee 9:d58e77ebd769 40 *
Nathan Yonkee 9:d58e77ebd769 41 * @param obj The pwmout object to initialize
Nathan Yonkee 9:d58e77ebd769 42 * @param pin The pwmout pin to initialize
Nathan Yonkee 9:d58e77ebd769 43 */
Nathan Yonkee 9:d58e77ebd769 44 void pwmout_init(pwmout_t *obj, PinName pin);
Nathan Yonkee 9:d58e77ebd769 45
Nathan Yonkee 9:d58e77ebd769 46 /** Deinitialize the pwmout object
Nathan Yonkee 9:d58e77ebd769 47 *
Nathan Yonkee 9:d58e77ebd769 48 * @param obj The pwmout object
Nathan Yonkee 9:d58e77ebd769 49 */
Nathan Yonkee 9:d58e77ebd769 50 void pwmout_free(pwmout_t *obj);
Nathan Yonkee 9:d58e77ebd769 51
Nathan Yonkee 9:d58e77ebd769 52 /** Set the output duty-cycle in range <0.0f, 1.0f>
Nathan Yonkee 9:d58e77ebd769 53 *
Nathan Yonkee 9:d58e77ebd769 54 * Value 0.0f represents 0 percentage, 1.0f represents 100 percent.
Nathan Yonkee 9:d58e77ebd769 55 * @param obj The pwmout object
Nathan Yonkee 9:d58e77ebd769 56 * @param percent The floating-point percentage number
Nathan Yonkee 9:d58e77ebd769 57 */
Nathan Yonkee 9:d58e77ebd769 58 void pwmout_write(pwmout_t *obj, float percent);
Nathan Yonkee 9:d58e77ebd769 59
Nathan Yonkee 9:d58e77ebd769 60 /** Read the current float-point output duty-cycle
Nathan Yonkee 9:d58e77ebd769 61 *
Nathan Yonkee 9:d58e77ebd769 62 * @param obj The pwmout object
Nathan Yonkee 9:d58e77ebd769 63 * @return A floating-point output duty-cycle
Nathan Yonkee 9:d58e77ebd769 64 */
Nathan Yonkee 9:d58e77ebd769 65 float pwmout_read(pwmout_t *obj);
Nathan Yonkee 9:d58e77ebd769 66
Nathan Yonkee 9:d58e77ebd769 67 /** Set the PWM period specified in seconds, keeping the duty cycle the same
Nathan Yonkee 9:d58e77ebd769 68 *
Nathan Yonkee 9:d58e77ebd769 69 * Periods smaller than microseconds (the lowest resolution) are set to zero.
Nathan Yonkee 9:d58e77ebd769 70 * @param obj The pwmout object
Nathan Yonkee 9:d58e77ebd769 71 * @param seconds The floating-point seconds period
Nathan Yonkee 9:d58e77ebd769 72 */
Nathan Yonkee 9:d58e77ebd769 73 void pwmout_period(pwmout_t *obj, float seconds);
Nathan Yonkee 9:d58e77ebd769 74
Nathan Yonkee 9:d58e77ebd769 75 /** Set the PWM period specified in miliseconds, keeping the duty cycle the same
Nathan Yonkee 9:d58e77ebd769 76 *
Nathan Yonkee 9:d58e77ebd769 77 * @param obj The pwmout object
Nathan Yonkee 9:d58e77ebd769 78 * @param ms The milisecond period
Nathan Yonkee 9:d58e77ebd769 79 */
Nathan Yonkee 9:d58e77ebd769 80 void pwmout_period_ms(pwmout_t *obj, int ms);
Nathan Yonkee 9:d58e77ebd769 81
Nathan Yonkee 9:d58e77ebd769 82 /** Set the PWM period specified in microseconds, keeping the duty cycle the same
Nathan Yonkee 9:d58e77ebd769 83 *
Nathan Yonkee 9:d58e77ebd769 84 * @param obj The pwmout object
Nathan Yonkee 9:d58e77ebd769 85 * @param us The microsecond period
Nathan Yonkee 9:d58e77ebd769 86 */
Nathan Yonkee 9:d58e77ebd769 87 void pwmout_period_us(pwmout_t *obj, int us);
Nathan Yonkee 9:d58e77ebd769 88
Nathan Yonkee 9:d58e77ebd769 89 /** Set the PWM pulsewidth specified in seconds, keeping the period the same.
Nathan Yonkee 9:d58e77ebd769 90 *
Nathan Yonkee 9:d58e77ebd769 91 * @param obj The pwmout object
Nathan Yonkee 9:d58e77ebd769 92 * @param seconds The floating-point pulsewidth in seconds
Nathan Yonkee 9:d58e77ebd769 93 */
Nathan Yonkee 9:d58e77ebd769 94 void pwmout_pulsewidth(pwmout_t *obj, float seconds);
Nathan Yonkee 9:d58e77ebd769 95
Nathan Yonkee 9:d58e77ebd769 96 /** Set the PWM pulsewidth specified in miliseconds, keeping the period the same.
Nathan Yonkee 9:d58e77ebd769 97 *
Nathan Yonkee 9:d58e77ebd769 98 * @param obj The pwmout object
Nathan Yonkee 9:d58e77ebd769 99 * @param ms The floating-point pulsewidth in miliseconds
Nathan Yonkee 9:d58e77ebd769 100 */
Nathan Yonkee 9:d58e77ebd769 101 void pwmout_pulsewidth_ms(pwmout_t *obj, int ms);
Nathan Yonkee 9:d58e77ebd769 102
Nathan Yonkee 9:d58e77ebd769 103 /** Set the PWM pulsewidth specified in microseconds, keeping the period the same.
Nathan Yonkee 9:d58e77ebd769 104 *
Nathan Yonkee 9:d58e77ebd769 105 * @param obj The pwmout object
Nathan Yonkee 9:d58e77ebd769 106 * @param us The floating-point pulsewidth in microseconds
Nathan Yonkee 9:d58e77ebd769 107 */
Nathan Yonkee 9:d58e77ebd769 108 void pwmout_pulsewidth_us(pwmout_t *obj, int us);
Nathan Yonkee 9:d58e77ebd769 109
Nathan Yonkee 9:d58e77ebd769 110 /**@}*/
Nathan Yonkee 9:d58e77ebd769 111
Nathan Yonkee 9:d58e77ebd769 112 #ifdef __cplusplus
Nathan Yonkee 9:d58e77ebd769 113 }
Nathan Yonkee 9:d58e77ebd769 114 #endif
Nathan Yonkee 9:d58e77ebd769 115
Nathan Yonkee 9:d58e77ebd769 116 #endif
Nathan Yonkee 9:d58e77ebd769 117
Nathan Yonkee 9:d58e77ebd769 118 #endif
Nathan Yonkee 9:d58e77ebd769 119
Nathan Yonkee 9:d58e77ebd769 120 /** @}*/