Harry Keane / X_NUCLEO_GNSS1A1

Dependents:   A_TeseoLocationNEW A_TeseoLocation

Embed: (wiki syntax)

« Back to documentation index

Teseo.h File Reference

Teseo.h File Reference

Teseo Location Class. More...

Go to the source code of this file.

Data Structures

struct  TeseoData
 Data structure that contains the driver informations. More...

Typedefs

typedef struct TeseoData tTeseoData
 Data structure that contains the driver informations.
typedef void(* teseo_app_output_callback )(uint32_t msgId, uint32_t msgType, tTeseoData *pData)
 Application register this out callback function and Teseo class will pass outputted information to application.
typedef void(* teseo_app_event_callback )(eTeseoLocEventType event, uint32_t data)
 Application register this event callback function and Teseo class will pass internal processing event to application.

Enumerations

enum  eStatus { TESEO_STATUS_SUCCESS = 0, TESEO_STATUS_FAILURE = 1 }
 

Enumeration structure that containes the two success states of a process.

More...
enum  eTeseoLocEventType { TESEO_LOC_EVENT_START_RESULT, TESEO_LOC_EVENT_STOP_RESULT }
 

Location event definitions.

More...
enum  eTeseoLocState
 

Teseo Location state.

More...
enum  eDebugState { DEBUG_OFF = 0, DEBUG_ON = 1 }
 

Enumeration structure that containes the two states of a debug process.

More...

Detailed Description

Teseo Location Class.

Author:
AST / Central Lab
Version:
V1.0.0
Date:
May-2017
Attention:

© COPYRIGHT(c) 2017 STMicroelectronics

Licensed under MCD-ST Liberty SW License Agreement V2, (the "License"); You may not use this file except in compliance with the License. You may obtain a copy of the License at:

http://www.st.com/software_license_agreement_liberty_v2

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file Teseo.h.


Typedef Documentation

typedef void(* teseo_app_event_callback)(eTeseoLocEventType event, uint32_t data)

Application register this event callback function and Teseo class will pass internal processing event to application.

Definition at line 151 of file Teseo.h.

typedef void(* teseo_app_output_callback)(uint32_t msgId, uint32_t msgType, tTeseoData *pData)

Application register this out callback function and Teseo class will pass outputted information to application.

Definition at line 149 of file Teseo.h.

typedef struct TeseoData tTeseoData

Data structure that contains the driver informations.


Enumeration Type Documentation

Enumeration structure that containes the two states of a debug process.

Enumerator:
DEBUG_OFF 

In this case, nothing will be printed on the console (nmea strings, positions and so on)

DEBUG_ON 

In this case, nmea strings and just acquired positions will be printed on the console.

Definition at line 123 of file Teseo.h.

enum eStatus

Enumeration structure that containes the two success states of a process.

Enumerator:
TESEO_STATUS_SUCCESS 

Success status.

TESEO_STATUS_FAILURE 

Failure status.

Definition at line 99 of file Teseo.h.

Location event definitions.

Enumerator:
TESEO_LOC_EVENT_START_RESULT 

Start result event.

TESEO_LOC_EVENT_STOP_RESULT 

Stop result event.

Definition at line 105 of file Teseo.h.

Teseo Location state.

Definition at line 113 of file Teseo.h.