rockblock_9704.h

Go to the documentation of this file.

#ifndef ROCKBLOCK_9704_H
#define ROCKBLOCK_9704_H
 
#if defined(__linux__) || defined(__APPLE__)
    #include "serial_presets/serial_linux/serial_linux.h"
#elif defined(_WIN32)
    #include "serial_presets/serial_windows/serial_windows.h"
#elif defined(ARDUINO) && defined(__cplusplus)
    #include "serial_presets/serial_arduino/serial_arduino.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "serial.h"
#include "jspr.h"
#include <stdio.h>
#include <stdint.h>
#include <stdbool.h>
#include <string.h>
#include <stddef.h>
 
typedef enum
{
    RB_MSG_STATUS_OK = 1,
 
    RB_MSG_STATUS_FAIL = -1
}rbMsgStatus_t;
 
typedef struct 
{
    void (*messageProvisioning)(const jsprMessageProvisioning_t *messageProvisioning);
 
    void (*moMessageComplete)(const uint16_t id, const rbMsgStatus_t status);
 
    void (*mtMessageComplete)(const uint16_t id, const rbMsgStatus_t status);
 
    void (*constellationState)(const jsprConstellationState_t *state);
 
    void (*moMessageStarted)(const uint16_t id);
 
    void (*messageActivityStatus)(const bool active);
} rbCallbacks_t;
 
void rbRegisterCallbacks(const rbCallbacks_t *callbacks);
 
#define BASE64_TEMP_BUFFER 2048U
 
#define RB9704_BAUD 230400U
 
#ifndef SERIAL_CONTEXT_SETUP_FUNC
    #ifdef __linux__
        #define SERIAL_CONTEXT_SETUP_FUNC setContextLinux
    #elif __APPLE__
        #define SERIAL_CONTEXT_SETUP_FUNC setContextLinux
    #elif _WIN32
        #define SERIAL_CONTEXT_SETUP_FUNC setContextWindows
    #elif ARDUINO
        #define SERIAL_CONTEXT_SETUP_FUNC setContextArduino
    #endif
#endif
 
typedef enum
{
    RAW_TOPIC = 244,
 
    PURPLE_TOPIC = 313,
 
    PINK_TOPIC = 314,
 
    RED_TOPIC = 315,
 
    ORANGE_TOPIC = 316,
 
    YELLOW_TOPIC = 317
} cloudloopTopics_t;
 
 
#if defined(ARDUINO) && defined(__cplusplus)
    } // End extern "C"
 
    bool rbBegin(Stream &port);
 
    // Redefine extern C
    extern "C" {
#else
    bool rbBegin(const char * port);
#endif
 
bool rbEnd(void);
 
bool rbSendMessage(const char * data, const size_t length, const int timeout);
 
bool rbSendMessageCloudloop(cloudloopTopics_t topic, const char * data, const size_t length, const int timeout);
 
bool rbSendMessageAny(uint16_t topic, const char * data, const size_t length, const int timeout);
 
size_t rbReceiveMessage(char ** buffer);
 
size_t rbReceiveMessageWithTopic(char ** buffer, uint16_t topic);
 
size_t rbReceiveMessageAsync(char ** buffer);
 
bool rbAcknowledgeReceiveHeadAsync(void);
 
void rbReceiveLockAsync(void);
 
void rbReceiveUnlockAsync(void);
 
void rbSendLockAsync(void);
 
void rbSendUnlockAsync(void);
 
bool rbSendMessageAsync(uint16_t topic, const char * data, const size_t length);
 
bool rbCancelMessage(const uint16_t topic, const uint16_t id);
 
void rbPoll(void);
 
int8_t rbGetSignal(void);
 
char * rbGetHwVersion(void);
 
char * rbGetSerialNumber(void);
 
char * rbGetImei(void);
 
int8_t rbGetBoardTemp(void);
 
bool rbGetCardPresent(void);
 
bool rbGetSimConnected(void);
 
char * rbGetIccid(void);
 
char *  rbGetFirmwareVersion(void);
 
bool rbResyncServiceConfig(void);
 
bool rbSetMessageActivityStatus(const bool enabled);
 
bool rbGetMessageActivityStatus(jsprMessageActivityStatus_t * status);
 
#if defined(KERMIT)
typedef void(*updateProgressCallback)(void * context, const unsigned long sofar, const unsigned long total);
 
bool rbUpdateFirmware (const char * firmwareFile, updateProgressCallback progress, void * context);
#endif
 
#ifdef RB_GPIO
#include "gpio.h"
 
bool rbBeginGpio(char * port, const rbGpioTable_t * gpioInfo, const int timeout);
 
bool rbEndGpio(const rbGpioTable_t * gpioInfo);
#endif
 
static uint16_t calculateCrc(const uint8_t * buffer, const size_t bufferLength, const uint16_t initialCRC);
 
static bool appendCrc(uint8_t * buffer, size_t length);
 
static size_t encodeData(const char * srcBuffer, const size_t srcLength, char * destBuffer, const size_t destLength);
 
static size_t decodeData(const char * srcBuffer, const size_t srcLength, char * destBuffer, const size_t destLength);
 
void clearLeftoverData(void);
 
bool setApi(void);
 
bool setSim(void);
 
bool setState(void);
 
static bool checkProvisioning(uint16_t topic);
 
static bool sendMoFromQueue(const int timeout);
 
static bool listenForMt(void);
 
static bool getHwInfo(jsprHwInfo_t * hwInfo);
 
static bool getSimStatus(jsprSimStatus_t * simStatus);
 
static bool sendMoFromQueueAsync(void);
 
static bool checkMoQueue(void);
 
 
#ifdef __cplusplus
}
#endif
 
#endif