framework/doc/swi_airvantage.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2014 Sierra Wireless and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Laurent Barthelemy for Sierra Wireless - initial API and implementation
 *     Romain Perier      for Sierra Wireless - initial API and implementation
 *******************************************************************************/


#ifndef SWI_AIRVANTAGE_INCLUDE_GUARD
#define SWI_AIRVANTAGE_INCLUDE_GUARD

#include <stdlib.h>
#include "returncodes.h"
#include "swi_dset.h"

#define SWI_AV_ERROR 1
#define SWI_AV_INFO 1

rc_ReturnCode_t swi_av_Init();

rc_ReturnCode_t swi_av_Destroy();


#define SWI_AV_CX_SYNC UINT_MAX ///< Value to be used to request synchronous connection to server using #swi_av_ConnectToServer

rc_ReturnCode_t swi_av_ConnectToServer
(
    unsigned int latency 

);



rc_ReturnCode_t swi_av_TriggerPolicy
(
    const char* policyPtr 

);


typedef struct swi_av_Asset swi_av_Asset_t;


rc_ReturnCode_t swi_av_asset_Create
(
    swi_av_Asset_t** asset, 


    const char* assetIdPtr  


);






rc_ReturnCode_t swi_av_asset_Start
(
    swi_av_Asset_t* asset 
);


rc_ReturnCode_t swi_av_asset_Destroy
(
    swi_av_Asset_t* asset 
);


// end General

typedef enum swi_av_timestamp{
  SWI_AV_TSTAMP_NO = 0,   
  SWI_AV_TSTAMP_AUTO = 1, 
}swi_av_timestamp_t;

rc_ReturnCode_t swi_av_asset_PushString
(
    swi_av_Asset_t* asset, 
    const char *pathPtr,   


    const char* policyPtr, 

    uint32_t timestamp,    

    const char* valuePtr   
);

rc_ReturnCode_t swi_av_asset_PushInteger
(
    swi_av_Asset_t* asset, 
    const char *pathPtr,   

    const char* policyPtr, 

    uint32_t timestamp,    

    int64_t value          
);

rc_ReturnCode_t swi_av_asset_PushFloat
(
    swi_av_Asset_t* asset, 
    const char *pathPtr,   

    const char* policyPtr, 

    uint32_t timestamp,    

    double value           
);

// end Data Sending Simple API

typedef struct swi_av_Table swi_av_Table_t;

typedef enum
{
  STORAGE_RAM = 0, 
  STORAGE_FLASH    
} swi_av_Table_Storage_t;

rc_ReturnCode_t swi_av_table_Create
(
    swi_av_Asset_t* asset,      
    swi_av_Table_t** table,     


    const char* pathPtr,        
    size_t numColumns,          
    const char** columnNamesPtr,
    const char* policyPtr,      
    swi_av_Table_Storage_t persisted, 

    int purge                   


);


rc_ReturnCode_t swi_av_table_Destroy
(
    swi_av_Table_t* table 
);


rc_ReturnCode_t swi_av_table_PushFloat
(
    swi_av_Table_t* table, 
    double value           
);



rc_ReturnCode_t swi_av_table_PushInteger
(
    swi_av_Table_t* table, 
    int value              
);

rc_ReturnCode_t swi_av_table_PushString
(
    swi_av_Table_t* table, 
    const char* value      
);


rc_ReturnCode_t swi_av_table_PushRow
(
    swi_av_Table_t* table 
);



// end Data Sending Advanced API

typedef void (*swi_av_DataWriteCB)
(
    swi_av_Asset_t *asset,        
    const char *pathPtr,          
    swi_dset_Iterator_t* data,    

    int ack_id,                   

    void *userDataPtr             
);



rc_ReturnCode_t swi_av_RegisterDataWrite
(
    swi_av_Asset_t *asset, 
    swi_av_DataWriteCB cb, 
    void * userDataPtr     
);


rc_ReturnCode_t swi_av_Acknowledge
(
    int ackId,             
    int status,            
    const char* errMsgPtr, 
    const char* policyPtr, 
    int persisted          

);




// end Data Reception

typedef rc_ReturnCode_t (*swi_av_updateNotificationCB)
(
    swi_av_Asset_t *asset,               
    const char* componentNamePtr,        

    const char* versionPtr,              

    const char *updateFilePathPtr,       


    swi_dset_Iterator_t* customParams,   

    void *userDataPtr                    
);


rc_ReturnCode_t swi_av_RegisterUpdateNotification
(
    swi_av_Asset_t* asset,           
    swi_av_updateNotificationCB cb,  

    void *userDataPtr                
);


rc_ReturnCode_t swi_av_SendUpdateResult
(
    swi_av_Asset_t* asset,        
    const char* componentNamePtr, 


    int updateResult              


);


// end Asset Update

#endif /* SWI_AIRVANTAGE_INCLUDE_GUARD */