no_os_gnss.h

Go to the documentation of this file.

/***************************************************************************/
 
#ifndef _NO_OS_GNSS_H_
#define _NO_OS_GNSS_H_
 
#include <stdint.h>
#include <stdbool.h>

struct no_os_gnss_pps_config {
    bool pps_enable;
    uint32_t frequency;
    uint32_t pulse_length;
};

struct no_os_gnss_precise_time {
    uint32_t unix_epoch;
    int32_t nanoseconds;
    uint32_t time_accuracy;
    bool time_valid;
    bool time_fully_resolved;
    bool date_valid;
    uint16_t year;
    uint8_t month;
    uint8_t day;
    uint8_t hour;
    uint8_t minute;
    uint8_t second;
};

struct no_os_gnss_position_data {
    uint8_t fix_quality;
    uint8_t satellites_used;
    float hdop;
    float altitude;
    float latitude;
    float longitude;
    bool position_valid;
    bool fix_valid;
};

struct no_os_gnss_platform_ops;

struct no_os_gnss_init_param {
    uint32_t device_id;
    struct no_os_gnss_pps_config pps_config;
    const struct no_os_gnss_platform_ops *platform_ops;
    void *extra;
};

struct no_os_gnss_desc {
    void *mutex;
    uint32_t device_id;
    const struct no_os_gnss_platform_ops *platform_ops;
    void *extra;
};

struct no_os_gnss_platform_ops {
    int32_t (*init)(struct no_os_gnss_desc **,
            const struct no_os_gnss_init_param *);
    int32_t (*refresh_timing_data)(struct no_os_gnss_desc *);
    int32_t (*is_timing_valid)(struct no_os_gnss_desc *, bool *);
    int32_t (*get_unified_timing)(struct no_os_gnss_desc *,
                      struct no_os_gnss_precise_time *);
    int32_t (*get_unix_epoch_unified)(struct no_os_gnss_desc *,
                      uint32_t *, uint32_t *);
    int32_t (*get_position_data)(struct no_os_gnss_desc *,
                     struct no_os_gnss_position_data *);
    int32_t (*remove)(struct no_os_gnss_desc *);
};
 
/* GNSS Public API Functions */

int32_t no_os_gnss_init(struct no_os_gnss_desc **desc,
            const struct no_os_gnss_init_param *param);

int32_t no_os_gnss_remove(struct no_os_gnss_desc *desc);

int32_t no_os_gnss_refresh_timing_data(struct no_os_gnss_desc *desc);

int32_t no_os_gnss_is_timing_valid(struct no_os_gnss_desc *desc, bool *valid);

int32_t no_os_gnss_get_unified_timing(struct no_os_gnss_desc *desc,
                      struct no_os_gnss_precise_time *timing);

int32_t no_os_gnss_get_unix_epoch_unified(struct no_os_gnss_desc *desc,
        uint32_t *epoch, uint32_t *fractional_seconds);

int32_t no_os_gnss_get_position_data(struct no_os_gnss_desc *desc,
                     struct no_os_gnss_position_data *position_data);
 
/* Platform-specific implementations */
extern const struct no_os_gnss_platform_ops nmea_ubx_gnss_ops;
 
#endif /* _NO_OS_GNSS_H_ */