nrf8001: documentation updates and showing relation to aci lib

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2015-03-18 17:55:19 -07:00
parent f53d8e79cc
commit e54d48f407
18 changed files with 88 additions and 57 deletions

View File

@ -857,9 +857,7 @@ EXCLUDE_SYMLINKS = NO
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*
EXCLUDE_PATTERNS = @PROJECT_SOURCE_DIR@/src/nrf8001/aci* \
@PROJECT_SOURCE_DIR@/src/nrf8001/lib* \
@PROJECT_SOURCE_DIR@/src/nrf8001/hal*
EXCLUDE_PATTERNS =
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
@ -870,7 +868,7 @@ EXCLUDE_PATTERNS = @PROJECT_SOURCE_DIR@/src/nrf8001/aci* \
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories use the pattern */test/*
EXCLUDE_SYMBOLS =
EXCLUDE_SYMBOLS = aci_*
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
# that contain example code fragments that are included (see the \include

View File

@ -21,10 +21,13 @@
/**
* @file
*
* @ingroup aci
*/
/**
* @defgroup aci aci
* @{
* @ingroup lib
* @ingroup aci-lib
*
* @brief Definitions for the ACI (Application Control Interface)
* @remarks

View File

@ -21,9 +21,7 @@
/**
* @file
*
* @ingroup aci
*
* @brief Definitions for the ACI (Application Control Interface) commands
* @remarks
*

View File

@ -19,8 +19,12 @@
* SOFTWARE.
*/
/*
* This file contents defines for the position of all the fields of ACI
/**
* @file
*
* @ingroup aci
*
* @brief This file contents defines for the position of all the fields of ACI
* command or event messages
*/

View File

@ -19,14 +19,14 @@
* SOFTWARE.
*/
/** @file
/**
* @file
* @brief Interface for buffer.
* @ingroup aci
*/
/** @defgroup aci_queue aci_queue
/**
@{
@ingroup aci_queue
*/
#ifndef ACI_QUEUE_H__

View File

@ -19,6 +19,11 @@
* SOFTWARE.
*/
/**
* @file
* @brief ACI setup functions
* @ingroup aci
*/
#ifndef H_ACI_SETUP
#define H_ACI_SETUP

View File

@ -22,7 +22,7 @@
/**
* @file
*
* @ingroup group_acilib
* @ingroup aci-lib
*
* @brief Internal prototype for acilib module.
*/

View File

@ -22,7 +22,7 @@
/**
* @file
*
* @ingroup group_acilib
* @ingroup aci-lib
*
* @brief Definitions for the acilib interfaces
*/

View File

@ -22,7 +22,7 @@
/**
* @file
*
* @ingroup group_acilib
* @ingroup aci-lib
*
* @brief Prototypes for the acilib interfaces.
*/

View File

@ -22,7 +22,7 @@
/**
* @file
*
* @ingroup group_acilib
* @ingroup aci-lib
*
* @brief Type used in the acilib interfaces
*/

View File

@ -19,8 +19,10 @@
* SOFTWARE.
*/
/** @file
/**
* @file
* @brief Defines for the different Bluetooth low energy boards
* @ingroup nrf8001
*/
#ifndef _BLE_BOARDS_H_

View File

@ -22,7 +22,7 @@
/**
* @file
*
* @ingroup group_acilib
* @ingroup aci-lib
*
* @brief Internal prototype for acilib module.
*/

View File

@ -19,13 +19,14 @@
* SOFTWARE.
*/
/** @file
/**
* @file
* @brief Interface for hal_aci_tl.
* @ingroup nrf8001
*/
/** @defgroup hal_aci_tl hal_aci_tl
/**
@{
@ingroup hal
@brief Module for the ACI Transport Layer interface
@details This module is responsible for sending and receiving messages over the ACI interface of the nRF8001 chip.

View File

@ -19,13 +19,15 @@
* SOFTWARE.
*/
/**
* @file
* @brief HAL specific macros
* @ingroup nrf8001
*/
#ifndef PLATFORM_H__
#define PLATFORM_H__
/** @file
* @brief
*/
//Board dependent defines
#if defined (__AVR__)
//For Arduino this AVR specific library has to be used for reading from Flash memory

View File

@ -19,16 +19,21 @@
* SOFTWARE.
*/
/**
* @file
* @defgroup aci-lib aci-library
* @brief ACI library
*
* Library for the logical part of the Application Controller Interface (ACI)
*
* @ingroup nrf8001
*/
#ifndef LIB_ACI_H__
#define LIB_ACI_H__
/** @file
* @brief ACI library
*/
/** @addtogroup lib_aci
@{
@brief Library for the logical part of the Application Controller Interface (ACI)
/**
* @{
*/
#ifdef __cplusplus

View File

@ -21,6 +21,35 @@
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
/**
* @file
* @brief C++ API for the Nordic Semiconductor NRF8001 Bluetooth Low Energy
* @ingroup nrf8001
*/
/**
* @defgroup nrf8001 libupm-nrf8001
* @ingroup wifi
*
* @sensor nrf8001
* @comname NRF8001 Bluetooth Low Energy
* @type wifi
* @man adafruit
* @con spi
*
* @brief nrf8001 Bluetooth Low Energy library
*
* These files define the NRF8001 C++ interface for lib-nrf8001. Interaction
* with this device is done through the ACI routines included with the library.
* You can use the nRF UART app in the Apple iOS app store and Google Play for
* Android 4.3 for Samsung Galaxy S4 to interact with a microcontroller running
* the 'hello world' example.
*
* @snippet nrf8001-helloworld.cxx Interesting
* @snippet nrf8001-broadcast.cxx Interesting
*/
#pragma once
#include <string>
@ -31,23 +60,5 @@
#include <lib_aci.h>
#include <aci_setup.h>
/**
* @brief nrf8001 Bluetooth Low Energy library
* @defgroup nrf8001 libupm-nrf8001
*/
/**
* @brief C++ API for the Nordic Semiconductor NRF8001 Bluetooth Low Energy
*
* This file defines the NRF8001 C++ interface for lib-nrf8001.
* Most of the interaction with this device is done using the ACI classes
* provided by Nordic Semiconductor. Please see our examples for further
* details.
*
* @ingroup nrf8001 spi
* @snippet nrf8001-helloworld.cxx Interesting
* @snippet nrf8001-broadcast.cxx Interesting
*/
void init_local_interfaces (aci_state_t* aci, uint8_t reqn, uint8_t rdyn, uint8_t rst);
void close_local_interfaces (aci_state_t* aci);

View File

@ -27,6 +27,12 @@
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file
* @brief BLE specific macros
* @ingroup nrf8001
*/
#ifndef UART_OVER_BLE_H__
#define UART_OVER_BLE_H__
@ -70,8 +76,4 @@ typedef struct
uint8_t uart_rts_remote; /**< State of the remote UART RTS */
} uart_over_ble_t;
/**
* @}
*/
#endif // UART_OVER_BLE_H__