doc/peripheral_io_doc.h

   1 /*
   2  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @ingroup   CAPI_SYSTEM_FRAMEWORK
  19  * @defgroup  CAPI_SYSTEM_PERIPHERAL_IO_MODULE Peripheral IO
  20  * @brief     The @ref CAPI_SYSTEM_PERIPHERAL_IO_MODULE API provides functions to make use of peripherals connected to the IoT device.
  21  *
  22  * @section   CAPI_SYSTEM_PERIPHERAL_IO_MODULE_HEADER Required Header
  23  *            \#include <peripheral_io.h>
  24  *
  25  * @section   CAPI_SYSTEM_PERIPHERAL_IO_MODULE_OVERVIEW Overview
  26  * This @ref CAPI_SYSTEM_PERIPHERAL_IO_MODULE API provides access to the low level device providers,
  27  * including GPIO, I2C, PWM, UART and SPI.
  28  */
  29
  30
  31 /**
  32  * @ingroup   CAPI_SYSTEM_PERIPHERAL_IO_MODULE
  33  * @defgroup  CAPI_SYSTEM_PERIPHERAL_IO_GPIO_MODULE GPIO
  34  * @brief     The @ref CAPI_SYSTEM_PERIPHERAL_IO_GPIO_MODULE API provides functions to control GPIO peripherals connected to the IoT device.
  35  *
  36  * @section   CAPI_SYSTEM_PERIPHERAL_IO_GPIO_MODULE_HEADER Required Header
  37  *            \#include <peripheral_io.h>
  38  *
  39  * @section   CAPI_SYSTEM_PERIPHERAL_IO_GPIO_MODULE_OVERVIEW Overview
  40  *
  41  * This @ref CAPI_SYSTEM_PERIPHERAL_IO_GPIO_MODULE API provides functions to control GPIO peripherals connected to the IoT device.
  42  *
  43  * @section   CAPI_SYSTEM_PERIPHERAL_IO_GPIO_MODULE_FEATURE Realted Features
  44  *
  45  * This API is related with the following feature:\n
  46  * - http://tizen.org/feature/peripheral_io.gpio\n
  47  *
  48  * It is recommended to use features in your application for reliability.\n
  49  *
  50  * You can check if a IoT device supports the related features for this API \n
  51  * by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
  52  *
  53  * To ensure your application is only running on the IoT device with specific features, \n
  54  * please define the features in your manifest file using the manifest editor in the SDK.\n
  55  *
  56  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
  57  */
  58
  59
  60 /**
  61  * @ingroup   CAPI_SYSTEM_PERIPHERAL_IO_MODULE
  62  * @defgroup  CAPI_SYSTEM_PERIPHERAL_IO_I2C_MODULE I2C
  63  * @brief     The @ref CAPI_SYSTEM_PERIPHERAL_IO_I2C_MODULE API provides functions to control I2C peripherals connected to the IoT device.
  64  *
  65  * @section   CAPI_SYSTEM_PERIPHERAL_IO_I2C_MODULE_HEADER Required Header
  66  *            \#include <peripheral_io.h>
  67  *
  68  * @section   CAPI_SYSTEM_PERIPHERAL_IO_I2C_MODULE_OVERVIEW Overview
  69  *
  70  * This @ref CAPI_SYSTEM_PERIPHERAL_IO_I2C_MODULE API provides functions to control I2C peripherals connected to the IoT device.
  71  *
  72  * @section   CAPI_SYSTEM_PERIPHERAL_IO_I2C_MODULE_FEATURE Realted Features
  73  *
  74  * This API is related with the following feature:\n
  75  * - http://tizen.org/feature/peripheral_io.i2c\n
  76  *
  77  * It is recommended to use features in your application for reliability.\n
  78  *
  79  * You can check if a IoT device supports the related features for this API \n
  80  * by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
  81  *
  82  * To ensure your application is only running on the IoT device with specific features, \n
  83  * please define the features in your manifest file using the manifest editor in the SDK.\n
  84  *
  85  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
  86  */
  87
  88
  89 /**
  90  * @ingroup   CAPI_SYSTEM_PERIPHERAL_IO_MODULE
  91  * @defgroup  CAPI_SYSTEM_PERIPHERAL_IO_SPI_MODULE SPI
  92  * @brief     The @ref CAPI_SYSTEM_PERIPHERAL_IO_SPI_MODULE API provides functions to control SPI peripherals connected to the IoT device.
  93  *
  94  * @section   CAPI_SYSTEM_PERIPHERAL_IO_SPI_MODULE_HEADER Required Header
  95  *            \#include <peripheral_io.h>
  96  *
  97  * @section   CAPI_SYSTEM_PERIPHERAL_IO_SPI_MODULE_OVERVIEW Overview
  98  *
  99  * This @ref CAPI_SYSTEM_PERIPHERAL_IO_SPI_MODULE API provides functions to control SPI peripherals connected to the IoT device.
 100  *
 101  * @section   CAPI_SYSTEM_PERIPHERAL_IO_SPI_MODULE_FEATURE Realted Features
 102  *
 103  * This API is related with the following feature:\n
 104  * - http://tizen.org/feature/peripheral_io.spi\n
 105  *
 106  * It is recommended to use features in your application for reliability.\n
 107  *
 108  * You can check if a IoT device supports the related features for this API \n
 109  * by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
 110  *
 111  * To ensure your application is only running on the IoT device with specific features, \n
 112  * please define the features in your manifest file using the manifest editor in the SDK.\n
 113  *
 114  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
 115  */
 116
 117
 118 /**
 119  * @ingroup   CAPI_SYSTEM_PERIPHERAL_IO_MODULE
 120  * @defgroup  CAPI_SYSTEM_PERIPHERAL_IO_UART_MODULE UART
 121  * @brief     The @ref CAPI_SYSTEM_PERIPHERAL_IO_UART_MODULE API provides functions to control UART peripherals connected to the IoT device.
 122  *
 123  * @section   CAPI_SYSTEM_PERIPHERAL_IO_UART_MODULE_HEADER Required Header
 124  *            \#include <peripheral_io.h>
 125  *
 126  * @section   CAPI_SYSTEM_PERIPHERAL_IO_UART_MODULE_OVERVIEW Overview
 127  *
 128  * This @ref CAPI_SYSTEM_PERIPHERAL_IO_UART_MODULE API provides functions to control UART peripherals connected to the IoT device.
 129  *
 130  * @section   CAPI_SYSTEM_PERIPHERAL_IO_UART_MODULE_FEATURE Realted Features
 131  *
 132  * This API is related with the following feature:\n
 133  * - http://tizen.org/feature/peripheral_io.uart\n
 134  *
 135  * It is recommended to use features in your application for reliability.\n
 136  *
 137  * You can check if a IoT device supports the related features for this API \n
 138  * by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
 139  *
 140  * To ensure your application is only running on the IoT device with specific features, \n
 141  * please define the features in your manifest file using the manifest editor in the SDK.\n
 142  *
 143  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
 144  */
 145
 146
 147 /**
 148  * @ingroup   CAPI_SYSTEM_PERIPHERAL_IO_MODULE
 149  * @defgroup  CAPI_SYSTEM_PERIPHERAL_IO_PWM_MODULE PWM
 150  * @brief     The @ref CAPI_SYSTEM_PERIPHERAL_IO_PWM_MODULE API provides functions to control PWM peripherals connected to the IoT device.
 151  *
 152  * @section   CAPI_SYSTEM_PERIPHERAL_IO_PWM_MODULE_HEADER Required Header
 153  *            \#include <peripheral_io.h>
 154  *
 155  * @section   CAPI_SYSTEM_PERIPHERAL_IO_PWM_MODULE_OVERVIEW Overview
 156  *
 157  * This @ref CAPI_SYSTEM_PERIPHERAL_IO_PWM_MODULE API provides functions to control PWM peripherals connected to the IoT device.
 158  *
 159  * @section   CAPI_SYSTEM_PERIPHERAL_IO_PWM_MODULE_FEATURE Realted Features
 160  *
 161  * This API is related with the following feature:\n
 162  * - http://tizen.org/feature/peripheral_io.pwm\n
 163  *
 164  * It is recommended to use features in your application for reliability.\n
 165  *
 166  * You can check if a IoT device supports the related features for this API \n
 167  * by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, and control your application's actions accordingly.\n
 168  *
 169  * To ensure your application is only running on the IoT device with specific features, \n
 170  * please define the features in your manifest file using the manifest editor in the SDK.\n
 171  *
 172  * More details on featuring your application can be found from <a href="https://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><b>Feature Element</b>.</a>
 173  */