u-blox / gnss

This class provides an API to communicate with a u-blox GNSS chip. The files here were originally part of the C027_Support library (https://developer.mbed.org/teams/ublox/code/C027_Support/ at revision 138:dafbbf31bf76) but have been separated out, primarily for use on the u-blox C030 board where the cellular interace portion of the C027_Support library will instead be provided through the new mbed Cellular API.

Dependents:   example-ublox-at-cellular-interface-ext example-low-power-sleep example-C030-out-of-box-demo example-C030-out-of-box-demo ... more

gnss.h@13:10108cd3ad23, 2018-06-08 (annotated)

Committer:
bqam
Date:
Fri Jun 08 11:18:19 2018 +0500
Revision:
13:10108cd3ad23
Parent:
12:a04f7eeece23
Child:
15:105cf3ca48c9
Power off function added

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rob.meades@u-blox.com 1:ef70a58a6c98 1 /* mbed Microcontroller Library
rob.meades@u-blox.com 1:ef70a58a6c98 2 * Copyright (c) 2017 u-blox
rob.meades@u-blox.com 1:ef70a58a6c98 3 *
rob.meades@u-blox.com 1:ef70a58a6c98 4 * Licensed under the Apache License, Version 2.0 (the "License");
rob.meades@u-blox.com 1:ef70a58a6c98 5 * you may not use this file except in compliance with the License.
rob.meades@u-blox.com 1:ef70a58a6c98 6 * You may obtain a copy of the License at
rob.meades@u-blox.com 1:ef70a58a6c98 7 *
rob.meades@u-blox.com 1:ef70a58a6c98 8 * http://www.apache.org/licenses/LICENSE-2.0
rob.meades@u-blox.com 1:ef70a58a6c98 9 *
rob.meades@u-blox.com 1:ef70a58a6c98 10 * Unless required by applicable law or agreed to in writing, software
rob.meades@u-blox.com 1:ef70a58a6c98 11 * distributed under the License is distributed on an "AS IS" BASIS,
rob.meades@u-blox.com 1:ef70a58a6c98 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
rob.meades@u-blox.com 1:ef70a58a6c98 13 * See the License for the specific language governing permissions and
rob.meades@u-blox.com 1:ef70a58a6c98 14 * limitations under the License.
rob.meades@u-blox.com 1:ef70a58a6c98 15 */
rob.meades@u-blox.com 1:ef70a58a6c98 16
rob.meades@u-blox.com 1:ef70a58a6c98 17 #ifndef GNSS_H
rob.meades@u-blox.com 1:ef70a58a6c98 18 #define GNSS_H
rob.meades@u-blox.com 1:ef70a58a6c98 19
rob.meades@u-blox.com 1:ef70a58a6c98 20 /**
rob.meades@u-blox.com 1:ef70a58a6c98 21 * @file gnss.h
rob.meades@u-blox.com 1:ef70a58a6c98 22 * This file defines a class that communicates with a u-blox GNSS chip.
rob.meades@u-blox.com 1:ef70a58a6c98 23 */
rob.meades@u-blox.com 1:ef70a58a6c98 24
rob.meades@u-blox.com 1:ef70a58a6c98 25 #include "mbed.h"
rob.meades@u-blox.com 1:ef70a58a6c98 26 #include "pipe.h"
rob.meades@u-blox.com 1:ef70a58a6c98 27 #include "serial_pipe.h"
rob.meades@u-blox.com 1:ef70a58a6c98 28
rob.meades@u-blox.com 4:82308d600690 29 #if defined (TARGET_UBLOX_C030) || defined (TARGET_UBLOX_C027)
RobMeades 2:b10ca4aa2e5e 30 # define GNSS_IF(onboard, shield) onboard
rob.meades@u-blox.com 1:ef70a58a6c98 31 #else
RobMeades 2:b10ca4aa2e5e 32 # define GNSS_IF(onboard, shield) shield
rob.meades@u-blox.com 1:ef70a58a6c98 33 #endif
rob.meades@u-blox.com 1:ef70a58a6c98 34
RobMeades 5:af4baf3c67f3 35 #ifdef TARGET_UBLOX_C027
rob.meades@u-blox.com 6:56eda66d585b 36 # define GNSSEN GPSEN
rob.meades@u-blox.com 6:56eda66d585b 37 # define GNSSTXD GPSTXD
rob.meades@u-blox.com 6:56eda66d585b 38 # define GNSSRXD GPSRXD
rob.meades@u-blox.com 6:56eda66d585b 39 # define GNSSBAUD GPSBAUD
RobMeades 5:af4baf3c67f3 40 #endif
RobMeades 5:af4baf3c67f3 41
fahim.alavi@u-blox.com 8:720841961804 42 #define UBX_FRAME_SIZE 8
fahim.alavi@u-blox.com 8:720841961804 43 #define RETRY 5
fahim.alavi@u-blox.com 8:720841961804 44 #define SYNC_CHAR_INDEX_1 0
fahim.alavi@u-blox.com 8:720841961804 45 #define SYNC_CHAR_INDEX_2 1
fahim.alavi@u-blox.com 8:720841961804 46 #define MSG_CLASS_INDEX 2
fahim.alavi@u-blox.com 8:720841961804 47 #define MSG_ID_INDEX 3
fahim.alavi@u-blox.com 8:720841961804 48 #define UBX_LENGTH_INDEX 4
fahim.alavi@u-blox.com 8:720841961804 49 #define UBX_PAYLOAD_INDEX 6
fahim.alavi@u-blox.com 8:720841961804 50
fahim.alavi@u-blox.com 8:720841961804 51 enum eUBX_MSG_CLASS {NAV = 0x01, ACK = 0x05, LOG = 0x21};
fahim.alavi@u-blox.com 8:720841961804 52
fahim.alavi@u-blox.com 8:720841961804 53 enum eUBX_MESSAGE {UBX_LOG_BATCH, UBX_ACK_ACK, UBX_ACK_NAK, UBX_NAV_ODO, UBX_NAV_PVT, UNKNOWN_UBX};
fahim.alavi@u-blox.com 8:720841961804 54
fahim.alavi@u-blox.com 9:cff83b9f5093 55 typedef struct UBX_ACK_ACK {
fahim.alavi@u-blox.com 8:720841961804 56 uint8_t msg_class;
fahim.alavi@u-blox.com 8:720841961804 57 uint8_t msg_id;
fahim.alavi@u-blox.com 8:720841961804 58
fahim.alavi@u-blox.com 9:cff83b9f5093 59 }tUBX_ACK_ACK;
fahim.alavi@u-blox.com 8:720841961804 60
fahim.alavi@u-blox.com 8:720841961804 61 typedef struct UBX_NAV_ODO {
fahim.alavi@u-blox.com 8:720841961804 62 uint8_t version;
fahim.alavi@u-blox.com 8:720841961804 63 uint8_t reserved[3];
fahim.alavi@u-blox.com 8:720841961804 64 uint32_t itow;
fahim.alavi@u-blox.com 8:720841961804 65 uint32_t distance;
fahim.alavi@u-blox.com 8:720841961804 66 uint32_t totalDistance;
fahim.alavi@u-blox.com 8:720841961804 67 uint32_t distanceSTD;
fahim.alavi@u-blox.com 8:720841961804 68 }tUBX_NAV_ODO;
fahim.alavi@u-blox.com 8:720841961804 69
fahim.alavi@u-blox.com 8:720841961804 70 typedef struct UBX_NAV_PVT {
fahim.alavi@u-blox.com 8:720841961804 71 uint32_t itow;
fahim.alavi@u-blox.com 8:720841961804 72 uint16_t year;
fahim.alavi@u-blox.com 8:720841961804 73 uint8_t month;
fahim.alavi@u-blox.com 8:720841961804 74 uint8_t day;
fahim.alavi@u-blox.com 8:720841961804 75 int32_t lon; // scaling 1e-7
fahim.alavi@u-blox.com 8:720841961804 76 int32_t lat; // scaling 1e-7
fahim.alavi@u-blox.com 8:720841961804 77 int32_t height;
fahim.alavi@u-blox.com 8:720841961804 78
fahim.alavi@u-blox.com 8:720841961804 79 }tUBX_NAV_PVT;
fahim.alavi@u-blox.com 8:720841961804 80
fahim.alavi@u-blox.com 8:720841961804 81 typedef struct UBX_LOG_BATCH {
fahim.alavi@u-blox.com 8:720841961804 82 uint32_t itow;
fahim.alavi@u-blox.com 8:720841961804 83 int32_t lon; // scaling 1e-7
fahim.alavi@u-blox.com 8:720841961804 84 int32_t lat; // scaling 1e-7
fahim.alavi@u-blox.com 8:720841961804 85 int32_t height;
fahim.alavi@u-blox.com 8:720841961804 86 uint32_t distance;
fahim.alavi@u-blox.com 8:720841961804 87 uint32_t totalDistance;
fahim.alavi@u-blox.com 8:720841961804 88 uint32_t distanceSTD;
fahim.alavi@u-blox.com 8:720841961804 89
fahim.alavi@u-blox.com 8:720841961804 90 }tUBX_LOG_BATCH;
fahim.alavi@u-blox.com 8:720841961804 91
Bilal Qamar 11:514ea8bf1dc8 92 typedef struct UBX_CFG_BATCH {
Bilal Qamar 11:514ea8bf1dc8 93 uint32_t version;
Bilal Qamar 11:514ea8bf1dc8 94 uint8_t flags;
Bilal Qamar 11:514ea8bf1dc8 95 uint32_t bufSize;
Bilal Qamar 11:514ea8bf1dc8 96 uint32_t notifThrs;
Bilal Qamar 12:a04f7eeece23 97 uint8_t pioId;
Bilal Qamar 12:a04f7eeece23 98 uint8_t reserved1;
Bilal Qamar 11:514ea8bf1dc8 99
Bilal Qamar 11:514ea8bf1dc8 100 }tUBX_CFG_BATCH;
Bilal Qamar 11:514ea8bf1dc8 101
rob.meades@u-blox.com 4:82308d600690 102 /** Basic GNSS parser class.
rob.meades@u-blox.com 1:ef70a58a6c98 103 */
rob.meades@u-blox.com 1:ef70a58a6c98 104 class GnssParser
rob.meades@u-blox.com 1:ef70a58a6c98 105 {
rob.meades@u-blox.com 1:ef70a58a6c98 106 public:
rob.meades@u-blox.com 4:82308d600690 107 /** Constructor.
rob.meades@u-blox.com 4:82308d600690 108 */
rob.meades@u-blox.com 1:ef70a58a6c98 109 GnssParser();
rob.meades@u-blox.com 4:82308d600690 110 /** Destructor.
rob.meades@u-blox.com 4:82308d600690 111 */
rob.meades@u-blox.com 1:ef70a58a6c98 112 virtual ~GnssParser(void);
rob.meades@u-blox.com 1:ef70a58a6c98 113
rob.meades@u-blox.com 4:82308d600690 114 /** Power-on/wake-up the GNSS.
rob.meades@u-blox.com 1:ef70a58a6c98 115 */
rob.meades@u-blox.com 1:ef70a58a6c98 116 virtual bool init(PinName pn) = 0;
rob.meades@u-blox.com 1:ef70a58a6c98 117
rob.meades@u-blox.com 1:ef70a58a6c98 118 enum {
rob.meades@u-blox.com 1:ef70a58a6c98 119 // getLine Responses
rob.meades@u-blox.com 1:ef70a58a6c98 120 WAIT = -1, //!< wait for more incoming data (the start of a message was found, or no data available)
rob.meades@u-blox.com 1:ef70a58a6c98 121 NOT_FOUND = 0, //!< a parser concluded the the current offset of the pipe doe not contain a valid message
rob.meades@u-blox.com 1:ef70a58a6c98 122
rob.meades@u-blox.com 1:ef70a58a6c98 123 #define LENGTH(x) (x & 0x00FFFF) //!< extract/mask the length
rob.meades@u-blox.com 1:ef70a58a6c98 124 #define PROTOCOL(x) (x & 0xFF0000) //!< extract/mask the type
rob.meades@u-blox.com 1:ef70a58a6c98 125
rob.meades@u-blox.com 1:ef70a58a6c98 126 UNKNOWN = 0x000000, //!< message type is unknown
rob.meades@u-blox.com 1:ef70a58a6c98 127 UBX = 0x100000, //!< message if of protocol NMEA
rob.meades@u-blox.com 1:ef70a58a6c98 128 NMEA = 0x200000 //!< message if of protocol UBX
rob.meades@u-blox.com 1:ef70a58a6c98 129 };
rob.meades@u-blox.com 1:ef70a58a6c98 130
rob.meades@u-blox.com 1:ef70a58a6c98 131 /** Get a line from the physical interface. This function
rob.meades@u-blox.com 4:82308d600690 132 * needs to be implemented in the inherited class.
rob.meades@u-blox.com 4:82308d600690 133 * @param buf the buffer to store it.
rob.meades@u-blox.com 4:82308d600690 134 * @param len size of the buffer.
rob.meades@u-blox.com 4:82308d600690 135 * @return type and length if something was found,
rob.meades@u-blox.com 4:82308d600690 136 * WAIT if not enough data is available,
rob.meades@u-blox.com 4:82308d600690 137 * NOT_FOUND if nothing was found
rob.meades@u-blox.com 4:82308d600690 138 */
rob.meades@u-blox.com 1:ef70a58a6c98 139 virtual int getMessage(char* buf, int len) = 0;
rob.meades@u-blox.com 1:ef70a58a6c98 140
rob.meades@u-blox.com 4:82308d600690 141 /** Send a buffer.
rob.meades@u-blox.com 4:82308d600690 142 * @param buf the buffer to write.
rob.meades@u-blox.com 4:82308d600690 143 * @param len size of the buffer to write.
rob.meades@u-blox.com 4:82308d600690 144 * @return bytes written.
rob.meades@u-blox.com 4:82308d600690 145 */
rob.meades@u-blox.com 1:ef70a58a6c98 146 virtual int send(const char* buf, int len);
rob.meades@u-blox.com 1:ef70a58a6c98 147
rob.meades@u-blox.com 1:ef70a58a6c98 148 /** send a NMEA message, this function just takes the
rob.meades@u-blox.com 4:82308d600690 149 * payload and calculates and adds checksum. ($ and *XX\r\n will be added).
rob.meades@u-blox.com 4:82308d600690 150 * @param buf the message payload to write.
rob.meades@u-blox.com 4:82308d600690 151 * @param len size of the message payload to write.
rob.meades@u-blox.com 4:82308d600690 152 * @return total bytes written.
rob.meades@u-blox.com 4:82308d600690 153 */
rob.meades@u-blox.com 1:ef70a58a6c98 154 virtual int sendNmea(const char* buf, int len);
rob.meades@u-blox.com 1:ef70a58a6c98 155
rob.meades@u-blox.com 4:82308d600690 156 /** Send a UBX message, this function just takes the
rob.meades@u-blox.com 4:82308d600690 157 * payload and calculates and adds checksum.
rob.meades@u-blox.com 4:82308d600690 158 * @param cls the UBX class id.
rob.meades@u-blox.com 4:82308d600690 159 * @param id the UBX message id.
rob.meades@u-blox.com 4:82308d600690 160 * @param buf the message payload to write.
rob.meades@u-blox.com 4:82308d600690 161 * @param len size of the message payload to write.
rob.meades@u-blox.com 4:82308d600690 162 * @return total bytes written.
rob.meades@u-blox.com 4:82308d600690 163 */
rob.meades@u-blox.com 1:ef70a58a6c98 164 virtual int sendUbx(unsigned char cls, unsigned char id,
rob.meades@u-blox.com 1:ef70a58a6c98 165 const void* buf = NULL, int len = 0);
rob.meades@u-blox.com 1:ef70a58a6c98 166
rob.meades@u-blox.com 1:ef70a58a6c98 167 /** Power off the GNSS, it can be again woken up by an
rob.meades@u-blox.com 4:82308d600690 168 * edge on the serial port on the external interrupt pin.
rob.meades@u-blox.com 1:ef70a58a6c98 169 */
rob.meades@u-blox.com 1:ef70a58a6c98 170 void powerOff(void);
bqam 13:10108cd3ad23 171
bqam 13:10108cd3ad23 172 /** Cuts off the power supply of GNSS by disabling gnssEnable pin
bqam 13:10108cd3ad23 173 * Backup supply is provided, can turn it on again by enabling PA15
bqam 13:10108cd3ad23 174 */
bqam 13:10108cd3ad23 175 void cutOffPower(void);
rob.meades@u-blox.com 1:ef70a58a6c98 176
rob.meades@u-blox.com 4:82308d600690 177 /** get the first character of a NMEA field.
rob.meades@u-blox.com 4:82308d600690 178 * @param ix the index of the field to find.
rob.meades@u-blox.com 4:82308d600690 179 * @param start the start of the buffer.
rob.meades@u-blox.com 4:82308d600690 180 * @param end the end of the buffer.
rob.meades@u-blox.com 4:82308d600690 181 * @return the pointer to the first character of the field.
rob.meades@u-blox.com 4:82308d600690 182 */
rob.meades@u-blox.com 1:ef70a58a6c98 183 static const char* findNmeaItemPos(int ix, const char* start, const char* end);
rob.meades@u-blox.com 1:ef70a58a6c98 184
rob.meades@u-blox.com 4:82308d600690 185 /** Extract a double value from a buffer containing a NMEA message.
rob.meades@u-blox.com 4:82308d600690 186 * @param ix the index of the field to extract.
rob.meades@u-blox.com 4:82308d600690 187 * @param buf the NMEA message.
rob.meades@u-blox.com 4:82308d600690 188 * @param len the size of the NMEA message.
rob.meades@u-blox.com 4:82308d600690 189 * @param val the extracted value.
rob.meades@u-blox.com 4:82308d600690 190 * @return true if successful, false otherwise.
rob.meades@u-blox.com 4:82308d600690 191 */
rob.meades@u-blox.com 1:ef70a58a6c98 192 static bool getNmeaItem(int ix, char* buf, int len, double& val);
rob.meades@u-blox.com 1:ef70a58a6c98 193
rob.meades@u-blox.com 4:82308d600690 194 /** Extract a interger value from a buffer containing a NMEA message.
rob.meades@u-blox.com 4:82308d600690 195 * @param ix the index of the field to extract.
rob.meades@u-blox.com 4:82308d600690 196 * @param buf the NMEA message.
rob.meades@u-blox.com 4:82308d600690 197 * @param len the size of the NMEA message.
rob.meades@u-blox.com 4:82308d600690 198 * @param val the extracted value.
rob.meades@u-blox.com 4:82308d600690 199 * @param base the numeric base to be used (e.g. 8, 10 or 16).
rob.meades@u-blox.com 4:82308d600690 200 * @return true if successful, false otherwise.
rob.meades@u-blox.com 4:82308d600690 201 */
rob.meades@u-blox.com 1:ef70a58a6c98 202 static bool getNmeaItem(int ix, char* buf, int len, int& val, int base/*=10*/);
rob.meades@u-blox.com 1:ef70a58a6c98 203
rob.meades@u-blox.com 4:82308d600690 204 /** Extract a char value from a buffer containing a NMEA message.
rob.meades@u-blox.com 4:82308d600690 205 * @param ix the index of the field to extract.
rob.meades@u-blox.com 4:82308d600690 206 * @param buf the NMEA message.
rob.meades@u-blox.com 4:82308d600690 207 * @param len the size of the NMEA message.
rob.meades@u-blox.com 4:82308d600690 208 * @param val the extracted value.
rob.meades@u-blox.com 4:82308d600690 209 * @return true if successful, false otherwise.
rob.meades@u-blox.com 4:82308d600690 210 */
rob.meades@u-blox.com 1:ef70a58a6c98 211 static bool getNmeaItem(int ix, char* buf, int len, char& val);
rob.meades@u-blox.com 1:ef70a58a6c98 212
rob.meades@u-blox.com 4:82308d600690 213 /** Extract a latitude/longitude value from a buffer containing a NMEA message.
rob.meades@u-blox.com 4:82308d600690 214 * @param ix the index of the field to extract (will extract ix and ix + 1),
rob.meades@u-blox.com 4:82308d600690 215 * @param buf the NMEA message,
rob.meades@u-blox.com 4:82308d600690 216 * @param len the size of the NMEA message,
rob.meades@u-blox.com 4:82308d600690 217 * @param val the extracted latitude or longitude,
rob.meades@u-blox.com 4:82308d600690 218 * @return true if successful, false otherwise.
rob.meades@u-blox.com 4:82308d600690 219 */
rob.meades@u-blox.com 1:ef70a58a6c98 220 static bool getNmeaAngle(int ix, char* buf, int len, double& val);
fahim.alavi@u-blox.com 8:720841961804 221
fahim.alavi@u-blox.com 8:720841961804 222 /** Enable UBX messages.
fahim.alavi@u-blox.com 8:720841961804 223 * @param none
Bilal Qamar 12:a04f7eeece23 224 * @return 1 if successful, false otherwise.
fahim.alavi@u-blox.com 8:720841961804 225 */
fahim.alavi@u-blox.com 8:720841961804 226 int enable_ubx();
rob.meades@u-blox.com 1:ef70a58a6c98 227
fahim.alavi@u-blox.com 8:720841961804 228 /** GET Message type of receiver UBX message
fahim.alavi@u-blox.com 8:720841961804 229 * @param buff the UXB message
fahim.alavi@u-blox.com 8:720841961804 230 * @return eUBX_MESSAGE
fahim.alavi@u-blox.com 8:720841961804 231 */
fahim.alavi@u-blox.com 8:720841961804 232 eUBX_MESSAGE get_ubx_message(char *);
fahim.alavi@u-blox.com 8:720841961804 233
fahim.alavi@u-blox.com 9:cff83b9f5093 234 /** Method to parse contents of UBX ACK-ACK/NAK and return messageid amd class for which ACK is received
fahim.alavi@u-blox.com 8:720841961804 235 * @param buff the UXB message
fahim.alavi@u-blox.com 9:cff83b9f5093 236 * @return tUBX_ACK_ACK
fahim.alavi@u-blox.com 8:720841961804 237 */
fahim.alavi@u-blox.com 9:cff83b9f5093 238 tUBX_ACK_ACK decode_ubx_cfg_ack_nak_msg(char *);
fahim.alavi@u-blox.com 8:720841961804 239
fahim.alavi@u-blox.com 8:720841961804 240 /** Method to parse contents of UBX_NAV_ODO and return decoded msg
fahim.alavi@u-blox.com 8:720841961804 241 * @param buff the UXB message
fahim.alavi@u-blox.com 8:720841961804 242 * @return tUBX_NAV_ODO
fahim.alavi@u-blox.com 8:720841961804 243 */
fahim.alavi@u-blox.com 8:720841961804 244 tUBX_NAV_ODO decode_ubx_nav_odo_msg(char *);
fahim.alavi@u-blox.com 8:720841961804 245
fahim.alavi@u-blox.com 8:720841961804 246 /** Method to parse contents of UBX_NAV_PVT and return decoded msg
fahim.alavi@u-blox.com 8:720841961804 247 * @param buff the UXB message
fahim.alavi@u-blox.com 8:720841961804 248 * @return tUBX_NAV_PVT
fahim.alavi@u-blox.com 8:720841961804 249 */
fahim.alavi@u-blox.com 8:720841961804 250 tUBX_NAV_PVT decode_ubx_nav_pvt_msg(char *);
fahim.alavi@u-blox.com 8:720841961804 251
fahim.alavi@u-blox.com 8:720841961804 252 /** Method to parse contents of UBX_LOG_BATCH and return decoded msg
fahim.alavi@u-blox.com 8:720841961804 253 * @param buff the UXB message
fahim.alavi@u-blox.com 8:720841961804 254 * @return tUBX_LOG_BATCH
fahim.alavi@u-blox.com 8:720841961804 255 */
fahim.alavi@u-blox.com 8:720841961804 256 tUBX_LOG_BATCH decode_ubx_log_batch_msg(char *);
fahim.alavi@u-blox.com 8:720841961804 257
fahim.alavi@u-blox.com 10:bfa9081e1d14 258 /** Method to send UBX LOG-RETRIEVEBATCH msg. This message is used to request batched data.
fahim.alavi@u-blox.com 10:bfa9081e1d14 259 * @param bool
fahim.alavi@u-blox.com 10:bfa9081e1d14 260 * @return int
fahim.alavi@u-blox.com 10:bfa9081e1d14 261 */
fahim.alavi@u-blox.com 10:bfa9081e1d14 262 int ubx_request_batched_data(bool sendMonFirst = false);
fahim.alavi@u-blox.com 10:bfa9081e1d14 263
rob.meades@u-blox.com 1:ef70a58a6c98 264 protected:
rob.meades@u-blox.com 1:ef70a58a6c98 265 /** Power on the GNSS module.
rob.meades@u-blox.com 1:ef70a58a6c98 266 */
rob.meades@u-blox.com 1:ef70a58a6c98 267 void _powerOn(void);
rob.meades@u-blox.com 1:ef70a58a6c98 268
rob.meades@u-blox.com 4:82308d600690 269 /** Get a line from the physical interface.
rob.meades@u-blox.com 4:82308d600690 270 * @param pipe the receiveing pipe to parse messages .
rob.meades@u-blox.com 4:82308d600690 271 * @param buf the buffer to store it.
rob.meades@u-blox.com 4:82308d600690 272 * @param len size of the buffer.
rob.meades@u-blox.com 4:82308d600690 273 * @return type and length if something was found,
rob.meades@u-blox.com 4:82308d600690 274 * WAIT if not enough data is available,
rob.meades@u-blox.com 4:82308d600690 275 * NOT_FOUND if nothing was found.
rob.meades@u-blox.com 4:82308d600690 276 */
rob.meades@u-blox.com 1:ef70a58a6c98 277 static int _getMessage(Pipe<char>* pipe, char* buf, int len);
rob.meades@u-blox.com 1:ef70a58a6c98 278
rob.meades@u-blox.com 1:ef70a58a6c98 279 /** Check if the current offset of the pipe contains a NMEA message.
rob.meades@u-blox.com 4:82308d600690 280 * @param pipe the receiveing pipe to parse messages.
rob.meades@u-blox.com 4:82308d600690 281 * @param len numer of bytes to parse at maximum.
rob.meades@u-blox.com 4:82308d600690 282 * @return length if something was found (including the NMEA frame),
rob.meades@u-blox.com 4:82308d600690 283 * WAIT if not enough data is available,
rob.meades@u-blox.com 4:82308d600690 284 * NOT_FOUND if nothing was found.
rob.meades@u-blox.com 4:82308d600690 285 */
rob.meades@u-blox.com 1:ef70a58a6c98 286 static int _parseNmea(Pipe<char>* pipe, int len);
rob.meades@u-blox.com 1:ef70a58a6c98 287
rob.meades@u-blox.com 1:ef70a58a6c98 288 /** Check if the current offset of the pipe contains a UBX message.
rob.meades@u-blox.com 4:82308d600690 289 * @param pipe the receiveing pipe to parse messages.
rob.meades@u-blox.com 4:82308d600690 290 * @param len numer of bytes to parse at maximum.
rob.meades@u-blox.com 4:82308d600690 291 * @return length if something was found (including the UBX frame),
rob.meades@u-blox.com 4:82308d600690 292 * WAIT if not enough data is available,
rob.meades@u-blox.com 4:82308d600690 293 * NOT_FOUND if nothing was found.
rob.meades@u-blox.com 4:82308d600690 294 */
rob.meades@u-blox.com 1:ef70a58a6c98 295 static int _parseUbx(Pipe<char>* pipe, int len);
rob.meades@u-blox.com 1:ef70a58a6c98 296
rob.meades@u-blox.com 1:ef70a58a6c98 297 /** Write bytes to the physical interface. This function
rob.meades@u-blox.com 4:82308d600690 298 * needs to be implemented by the inherited class.
rob.meades@u-blox.com 4:82308d600690 299 * @param buf the buffer to write.
rob.meades@u-blox.com 4:82308d600690 300 * @param len size of the buffer to write.
rob.meades@u-blox.com 4:82308d600690 301 * @return bytes written.
rob.meades@u-blox.com 4:82308d600690 302 */
rob.meades@u-blox.com 1:ef70a58a6c98 303 virtual int _send(const void* buf, int len) = 0;
rob.meades@u-blox.com 1:ef70a58a6c98 304
rob.meades@u-blox.com 1:ef70a58a6c98 305 static const char _toHex[16]; //!< num to hex conversion
rob.meades@u-blox.com 4:82308d600690 306 DigitalInOut *_gnssEnable; //!< IO pin that enables GNSS
rob.meades@u-blox.com 1:ef70a58a6c98 307 };
rob.meades@u-blox.com 1:ef70a58a6c98 308
rob.meades@u-blox.com 4:82308d600690 309 /** GNSS class which uses a serial port as physical interface.
rob.meades@u-blox.com 4:82308d600690 310 */
rob.meades@u-blox.com 1:ef70a58a6c98 311 class GnssSerial : public SerialPipe, public GnssParser
rob.meades@u-blox.com 1:ef70a58a6c98 312 {
rob.meades@u-blox.com 1:ef70a58a6c98 313 public:
rob.meades@u-blox.com 4:82308d600690 314 /** Constructor.
rob.meades@u-blox.com 4:82308d600690 315 * @param tx is the serial ports transmit pin (GNSS to CPU).
rob.meades@u-blox.com 4:82308d600690 316 * @param rx is the serial ports receive pin (CPU to GNSS).
rob.meades@u-blox.com 4:82308d600690 317 * @param baudrate the baudrate of the GNSS use 9600.
rob.meades@u-blox.com 4:82308d600690 318 * @param rxSize the size of the serial rx buffer.
rob.meades@u-blox.com 4:82308d600690 319 * @param txSize the size of the serial tx buffer.
rob.meades@u-blox.com 4:82308d600690 320 */
RobMeades 2:b10ca4aa2e5e 321 GnssSerial(PinName tx GNSS_IF( = GNSSTXD, = D8 /* = D8 */), // resistor on shield not populated
RobMeades 2:b10ca4aa2e5e 322 PinName rx GNSS_IF( = GNSSRXD, = D9 /* = D9 */), // resistor on shield not populated
rob.meades@u-blox.com 1:ef70a58a6c98 323 int baudrate GNSS_IF( = GNSSBAUD, = 9600 ),
rob.meades@u-blox.com 1:ef70a58a6c98 324 int rxSize = 256 ,
rob.meades@u-blox.com 1:ef70a58a6c98 325 int txSize = 128 );
rob.meades@u-blox.com 1:ef70a58a6c98 326
rob.meades@u-blox.com 4:82308d600690 327 /** Destructor.
rob.meades@u-blox.com 4:82308d600690 328 */
rob.meades@u-blox.com 1:ef70a58a6c98 329 virtual ~GnssSerial(void);
rob.meades@u-blox.com 1:ef70a58a6c98 330
rob.meades@u-blox.com 4:82308d600690 331 /** Initialise the GNSS device.
rob.meades@u-blox.com 4:82308d600690 332 * @param pn NOT USED.
rob.meades@u-blox.com 4:82308d600690 333 * @return true if successful, otherwise false.
rob.meades@u-blox.com 4:82308d600690 334 */
rob.meades@u-blox.com 1:ef70a58a6c98 335 virtual bool init(PinName pn = NC);
rob.meades@u-blox.com 1:ef70a58a6c98 336
rob.meades@u-blox.com 1:ef70a58a6c98 337 /** Get a line from the physical interface.
rob.meades@u-blox.com 4:82308d600690 338 * @param buf the buffer to store it.
rob.meades@u-blox.com 4:82308d600690 339 * @param len size of the buffer.
rob.meades@u-blox.com 4:82308d600690 340 * @return type and length if something was found,
rob.meades@u-blox.com 4:82308d600690 341 * WAIT if not enough data is available,
rob.meades@u-blox.com 4:82308d600690 342 * NOT_FOUND if nothing was found.
rob.meades@u-blox.com 4:82308d600690 343 */
rob.meades@u-blox.com 1:ef70a58a6c98 344 virtual int getMessage(char* buf, int len);
rob.meades@u-blox.com 1:ef70a58a6c98 345
rob.meades@u-blox.com 1:ef70a58a6c98 346 protected:
rob.meades@u-blox.com 1:ef70a58a6c98 347 /** Write bytes to the physical interface.
rob.meades@u-blox.com 4:82308d600690 348 * @param buf the buffer to write.
rob.meades@u-blox.com 4:82308d600690 349 * @param len size of the buffer to write.
rob.meades@u-blox.com 4:82308d600690 350 * @return bytes written.
rob.meades@u-blox.com 4:82308d600690 351 */
rob.meades@u-blox.com 1:ef70a58a6c98 352 virtual int _send(const void* buf, int len);
rob.meades@u-blox.com 1:ef70a58a6c98 353 };
rob.meades@u-blox.com 1:ef70a58a6c98 354
rob.meades@u-blox.com 1:ef70a58a6c98 355 /** GNSS class which uses a i2c as physical interface.
rob.meades@u-blox.com 1:ef70a58a6c98 356 */
rob.meades@u-blox.com 1:ef70a58a6c98 357 class GnssI2C : public I2C, public GnssParser
rob.meades@u-blox.com 1:ef70a58a6c98 358 {
rob.meades@u-blox.com 1:ef70a58a6c98 359 public:
rob.meades@u-blox.com 4:82308d600690 360 /** Constructor.
rob.meades@u-blox.com 4:82308d600690 361 * @param sda is the I2C SDA pin (between CPU and GNSS).
rob.meades@u-blox.com 4:82308d600690 362 * @param scl is the I2C SCL pin (CPU to GNSS).
rob.meades@u-blox.com 4:82308d600690 363 * @param adr the I2C address of the GNSS set to (66<<1).
rob.meades@u-blox.com 4:82308d600690 364 * @param rxSize the size of the serial rx buffer.
rob.meades@u-blox.com 4:82308d600690 365 */
RobMeades 2:b10ca4aa2e5e 366 GnssI2C(PinName sda GNSS_IF( = NC, = /* D16 TODO */ NC ),
RobMeades 2:b10ca4aa2e5e 367 PinName scl GNSS_IF( = NC, = /* D17 TODO */ NC ),
RobMeades 2:b10ca4aa2e5e 368 unsigned char i2cAdr GNSS_IF( = (66<<1), = (66<<1) ),
RobMeades 2:b10ca4aa2e5e 369 int rxSize = 256 );
rob.meades@u-blox.com 4:82308d600690 370 /** Destructor
rob.meades@u-blox.com 4:82308d600690 371 */
rob.meades@u-blox.com 1:ef70a58a6c98 372 virtual ~GnssI2C(void);
rob.meades@u-blox.com 1:ef70a58a6c98 373
rob.meades@u-blox.com 4:82308d600690 374 /** Helper function to probe the i2c device.
rob.meades@u-blox.com 4:82308d600690 375 * @param pn the power-on pin for the chip.
rob.meades@u-blox.com 4:82308d600690 376 * @return true if successfully detected the GNSS chip.
rob.meades@u-blox.com 4:82308d600690 377 */
rob.meades@u-blox.com 1:ef70a58a6c98 378 virtual bool init(PinName pn = GNSS_IF( NC, NC /* D7 resistor R67 on shield not mounted */));
rob.meades@u-blox.com 1:ef70a58a6c98 379
rob.meades@u-blox.com 1:ef70a58a6c98 380 /** Get a line from the physical interface.
rob.meades@u-blox.com 4:82308d600690 381 * @param buf the buffer to store it.
rob.meades@u-blox.com 4:82308d600690 382 * @param len size of the buffer.
rob.meades@u-blox.com 4:82308d600690 383 * @return type and length if something was found,
rob.meades@u-blox.com 4:82308d600690 384 * WAIT if not enough data is available,
rob.meades@u-blox.com 4:82308d600690 385 * NOT_FOUND if nothing was found.
rob.meades@u-blox.com 4:82308d600690 386 */
rob.meades@u-blox.com 1:ef70a58a6c98 387 virtual int getMessage(char* buf, int len);
rob.meades@u-blox.com 1:ef70a58a6c98 388
rob.meades@u-blox.com 4:82308d600690 389 /** Send a buffer.
rob.meades@u-blox.com 4:82308d600690 390 * @param buf the buffer to write.
rob.meades@u-blox.com 4:82308d600690 391 * @param len size of the buffer to write.
rob.meades@u-blox.com 4:82308d600690 392 * @return bytes written.
rob.meades@u-blox.com 4:82308d600690 393 */
rob.meades@u-blox.com 1:ef70a58a6c98 394 virtual int send(const char* buf, int len);
rob.meades@u-blox.com 1:ef70a58a6c98 395
rob.meades@u-blox.com 4:82308d600690 396 /** Send an NMEA message, this function just takes the
rob.meades@u-blox.com 4:82308d600690 397 * payload and calculates and adds checksum ($ and *XX\r\n will be added).
rob.meades@u-blox.com 4:82308d600690 398 * @param buf the message payload to write.
rob.meades@u-blox.com 4:82308d600690 399 * @param len size of the message payload to write.
rob.meades@u-blox.com 4:82308d600690 400 * @return total bytes written.
rob.meades@u-blox.com 4:82308d600690 401 */
rob.meades@u-blox.com 1:ef70a58a6c98 402 virtual int sendNmea(const char* buf, int len);
rob.meades@u-blox.com 1:ef70a58a6c98 403
rob.meades@u-blox.com 4:82308d600690 404 /** Send a UBX message, this function just takes the
rob.meades@u-blox.com 4:82308d600690 405 * payload and calculates and adds checksum.
rob.meades@u-blox.com 4:82308d600690 406 * @param cls the UBX class id.
rob.meades@u-blox.com 4:82308d600690 407 * @param id the UBX message id.
rob.meades@u-blox.com 4:82308d600690 408 * @param buf the message payload to write.
rob.meades@u-blox.com 4:82308d600690 409 * @param len size of the message payload to write.
rob.meades@u-blox.com 4:82308d600690 410 * @return total bytes written.
rob.meades@u-blox.com 4:82308d600690 411 */
rob.meades@u-blox.com 1:ef70a58a6c98 412 virtual int sendUbx(unsigned char cls, unsigned char id,
rob.meades@u-blox.com 1:ef70a58a6c98 413 const void* buf = NULL, int len = 0);
rob.meades@u-blox.com 1:ef70a58a6c98 414
rob.meades@u-blox.com 1:ef70a58a6c98 415 protected:
rob.meades@u-blox.com 4:82308d600690 416 /** Check if the port is writeable (like SerialPipe)
rob.meades@u-blox.com 4:82308d600690 417 * @return true if writeable
rob.meades@u-blox.com 4:82308d600690 418 */
rob.meades@u-blox.com 4:82308d600690 419 bool writeable(void) {return true;}
rob.meades@u-blox.com 1:ef70a58a6c98 420
rob.meades@u-blox.com 4:82308d600690 421 /** Write a character (like SerialPipe).
rob.meades@u-blox.com 4:82308d600690 422 * @param c the character to write.
rob.meades@u-blox.com 4:82308d600690 423 * @return true if succesffully written .
rob.meades@u-blox.com 4:82308d600690 424 */
rob.meades@u-blox.com 4:82308d600690 425 bool putc(int c) {char ch = c; return send(&ch, 1);}
rob.meades@u-blox.com 1:ef70a58a6c98 426
rob.meades@u-blox.com 1:ef70a58a6c98 427 /** Write bytes to the physical interface.
rob.meades@u-blox.com 4:82308d600690 428 * @param buf the buffer to write.
rob.meades@u-blox.com 4:82308d600690 429 * @param len size of the buffer to write.
rob.meades@u-blox.com 4:82308d600690 430 * @return bytes written.
rob.meades@u-blox.com 4:82308d600690 431 */
rob.meades@u-blox.com 1:ef70a58a6c98 432 virtual int _send(const void* buf, int len);
rob.meades@u-blox.com 1:ef70a58a6c98 433
rob.meades@u-blox.com 4:82308d600690 434 /** Read bytes from the physical interface.
rob.meades@u-blox.com 4:82308d600690 435 * @param buf the buffer to read into.
rob.meades@u-blox.com 4:82308d600690 436 * @param len size of the read buffer .
rob.meades@u-blox.com 4:82308d600690 437 * @return bytes read.
rob.meades@u-blox.com 4:82308d600690 438 */
rob.meades@u-blox.com 1:ef70a58a6c98 439 int _get(char* buf, int len);
rob.meades@u-blox.com 1:ef70a58a6c98 440
rob.meades@u-blox.com 4:82308d600690 441 Pipe<char> _pipe; //!< the rx pipe.
rob.meades@u-blox.com 4:82308d600690 442 unsigned char _i2cAdr; //!< the i2c address.
rob.meades@u-blox.com 4:82308d600690 443 static const char REGLEN; //!< the length i2c register address.
rob.meades@u-blox.com 4:82308d600690 444 static const char REGSTREAM;//!< the stream i2c register address.
rob.meades@u-blox.com 1:ef70a58a6c98 445 };
rob.meades@u-blox.com 1:ef70a58a6c98 446
rob.meades@u-blox.com 1:ef70a58a6c98 447 #endif
rob.meades@u-blox.com 1:ef70a58a6c98 448
rob.meades@u-blox.com 1:ef70a58a6c98 449 // End Of File