kvrlib.h

Go to the documentation of this file.

/*
 *                   Copyright 2017 by KVASER AB, SWEDEN
 *
 *                        WWW: http://www.kvaser.com
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license.
 *
*/

#ifndef KVRLIB_H_
#define KVRLIB_H_


#include <windows.h>

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>


typedef enum {
  kvrOK                    =  0,  
  kvrERR_NOT_INITIALIZED   = -1,  
  kvrERR_GENERIC           = -2,  
  kvrERR_CHECKSUM          = -3,  
  kvrERR_PARAMETER         = -4,  
  kvrERR_PASSWORD          = -5,  
  kvrERR_BLANK             = -6,  
  kvrERR_NO_DEVICE         = -7,  
  kvrERR_NO_ANSWER         = -8,  
  kvrERR_NOT_IMPLEMENTED   = -9,  
  kvrERR_PERMISSION_DENIED = -10, 
  kvrERR_OUT_OF_SPACE      = -11, 
  kvrERR_NO_SERVICE        = -12, 
  kvrERR_DUPLICATED_DEVICE = -13, 
  kvrERR_XML_VALIDATION    = -14, 
  kvrERR_BUFFER_TOO_SMALL  = -15, 
  /* Remember to update the list of errorstrings (error_text_array) in the library as well. */
} kvrStatus;

typedef int32_t kvrConfigHandle;


#define kvrConfigMode_R         0  
#define kvrConfigMode_RW        1  
#define kvrConfigMode_ERASE     2  
#define kvrServiceState_VOID               0  
#define kvrServiceState_AVAILABLE          1  
#define kvrServiceState_DISCOVERED         2  
#define kvrServiceState_STARTING           3
#define kvrServiceState_STARTED            4  
#define kvrServiceState_CONNECTION_DOWN    5  
#define kvrServiceState_CONNECTION_UP      6
#define kvrServiceState_REDISCOVER         7  
#define kvrServiceState_UNWILLING          8  
#define kvrServiceState_REDISCOVER_PENDING 9  
#define kvrServiceState_CLOSING            10 
#define kvrServiceState_REMOVE_ME          11 
#define kvrServiceState_STANDBY            12
#define kvrServiceState_CONFIG_CHANGED     13 
#define kvrServiceState_STOPPING           14 
#define kvrServiceState_INSTALLING         15 
#define kvrStartInfo_NONE               0 
#define kvrStartInfo_START_OK           1 
#define kvrStartInfo_ERR_IN_USE         2 
#define kvrStartInfo_ERR_PWD            3 
#define kvrStartInfo_ERR_NOTME          4 
#define kvrStartInfo_ERR_CONFIGURING    5 
#define kvrStartInfo_ERR_PARAM          6 
#define kvrStartInfo_ERR_ENCRYPTION_PWD 7 
kvrStatus WINAPI kvrConfigOpen(int32_t can_channel_no,
                               int32_t mode,
                               const char *password,
                               kvrConfigHandle *handle);


kvrStatus WINAPI kvrConfigActiveProfileSet (int32_t can_channel_no, int32_t profile_number);

kvrStatus WINAPI kvrConfigActiveProfileGet (int32_t can_channel_no, int32_t *profile_number);

kvrStatus WINAPI kvrConfigNoProfilesGet(int32_t can_channel_no, int32_t *no_profiles);


kvrStatus WINAPI kvrConfigOpenEx(int32_t can_channel_no,
                               int32_t mode,
                               const char *password,
                               kvrConfigHandle *handle,
                               uint32_t profile_no);

void WINAPI kvrConfigClose(kvrConfigHandle handle);

kvrStatus WINAPI kvrConfigVerifyXml(const char *xml_buffer,
                                    char *err_buffer,
                                    uint32_t err_buffer_size);

kvrStatus WINAPI kvrConfigSet(kvrConfigHandle handle, const char *xml_buffer);

kvrStatus WINAPI kvrConfigGet(kvrConfigHandle handle,
                              char *xml_buffer,
                              uint32_t xml_buffer_size);

kvrStatus WINAPI kvrConfigInfoGet(int32_t can_channel_no,
                                  int32_t profile_no,
                                  char *xml_buffer,
                                  uint32_t xml_buffer_size);

kvrStatus WINAPI kvrConfigClear(kvrConfigHandle handle);

typedef struct {
  uint32_t type;        
  uint8_t address[20];  
} kvrAddress;


typedef struct {
  uint32_t version;
  uint32_t capability;        
  uint32_t group_cipher;      
  uint32_t list_cipher_auth;  
} kvrCipherInfoElement;

#define kvrAddressType_UNKNOWN     0  
#define kvrAddressType_IPV4        1  
#define kvrAddressType_IPV6        2  
#define kvrAddressType_IPV4_PORT   3  
#define kvrAddressType_MAC         4  
typedef int32_t kvrRssiHistory;

typedef uint32_t kvrRttHistory;

#define kvrNetworkState_UNKNOWN                0  
#define kvrNetworkState_INVALID                1  
#define kvrNetworkState_STARTUP                2  
#define kvrNetworkState_INITIALIZING           3  
#define kvrNetworkState_NOT_CONNECTED          4  
#define kvrNetworkState_CONNECTION_DELAY       5  
#define kvrNetworkState_CONNECTING             6  
#define kvrNetworkState_CONNECTED              7  
#define kvrNetworkState_AUTHENTICATING         8  
#define kvrNetworkState_AUTHENTICATION_FAILED  9  
#define kvrNetworkState_ONLINE                 10 
#define kvrNetworkState_FAILED_MIC             11 
#define kvrBss_INFRASTRUCTURE     0 
#define kvrBss_INDEPENDENT        1 
#define kvrBss_ANY                2 
#define kvrRegulatoryDomain_JAPAN_TELEC         0  
#define kvrRegulatoryDomain_EUROPE_ETSI         1  
#define kvrRegulatoryDomain_NORTH_AMERICA_FCC   2  
#define kvrRegulatoryDomain_WORLD               3  
#define kvrRegulatoryDomain_CHINA_MII           4  
 kvrStatus WINAPI kvrNetworkConnectionTest(kvrConfigHandle handle,
                                           int32_t active);

kvrStatus WINAPI kvrNetworkGetRssiRtt(kvrConfigHandle handle,
                                      kvrRssiHistory *rssi,
                                      uint32_t rssi_size,
                                      uint32_t *rssi_count,
                                      kvrRttHistory *rtt,
                                      uint32_t rtt_size,
                                      uint32_t *rtt_count);

kvrStatus WINAPI kvrWlanStartScan(kvrConfigHandle handle,
                                  int32_t active,
                                  int32_t bss_type,
                                  int32_t domain);


kvrStatus WINAPI kvrWlanGetScanResults(kvrConfigHandle handle,
                                       int32_t *rssi,
                                       int32_t *channel,
                                       kvrAddress *mac,
                                       int32_t *bss_type,
                                       char *ssid,
                                       uint32_t *capability,
                                       uint32_t *type_wpa,
                                       kvrCipherInfoElement *wpa_info,
                                       kvrCipherInfoElement *rsn_info);

kvrStatus WINAPI kvrNetworkGetHostName(kvrConfigHandle handle,
                                       char* buffer, uint32_t buffer_size);

kvrStatus WINAPI kvrHostName(uint32_t ean_hi, uint32_t ean_lo, uint32_t ser_no,
                             char* buffer, uint32_t buffer_size);


kvrStatus WINAPI kvrNetworkGetConnectionStatus(kvrConfigHandle handle,
                                               int32_t *state,
                                               int32_t *tx_rate,
                                               int32_t *rx_rate,
                                               int32_t *channel,
                                               int32_t *rssi,
                                               int32_t *tx_power);

kvrStatus WINAPI kvrNetworkGetAddressInfo(kvrConfigHandle handle,
                                          kvrAddress *address1,
                                          kvrAddress *address2,
                                          kvrAddress *netmask,
                                          kvrAddress *gateway,
                                          int32_t *dhcp);

#define kvrDeviceUsage_UNKNOWN   0 
#define kvrDeviceUsage_FREE      1 
#define kvrDeviceUsage_REMOTE    2 
#define kvrDeviceUsage_USB       3 
#define kvrDeviceUsage_CONFIG    4 
#define kvrAccessibility_UNKNOWN      0 
#define kvrAccessibility_PUBLIC       1 
#define kvrAccessibility_PROTECTED    2 
#define kvrAccessibility_PRIVATE      3 
#define kvrRemoteState_VOID                  0  
#define kvrRemoteState_AVAILABLE             1  
#define kvrRemoteState_DISCOVERED            2  
#define kvrRemoteState_STARTING              3  
#define kvrRemoteState_STARTED               4  
#define kvrRemoteState_CONNECTION_DOWN       5  
#define kvrRemoteState_CONNECTION_UP         6  
#define kvrRemoteState_REDISCOVER            7  
#define kvrRemoteState_UNWILLING             8  
#define kvrRemoteState_REDISCOVER_PENDING    9  
#define kvrRemoteState_CLOSING               10 
#define kvrRemoteState_REMOVE_ME             11 
#define kvrRemoteState_STANDBY               12 
#define kvrRemoteState_CONFIG_CHANGED        13 
#define kvrRemoteState_STOPPING              14 
#define kvrRemoteState_INSTALLING            15 
#define kvrAvailability_NONE             0 
#define kvrAvailability_FOUND_BY_SCAN    1 
#define kvrAvailability_STORED           2 
typedef struct {
  uint32_t      struct_size;     
  uint32_t      ean_hi;          
  uint32_t      ean_lo;          
  uint32_t      ser_no;          
  int32_t       fw_major_ver;    
  int32_t       fw_minor_ver;    
  int32_t       fw_build_ver;    
  char          name[256];       
  char          host_name[256];  
  int32_t       usage;           
  int32_t       accessibility;   
  char          accessibility_pwd[256];  
  kvrAddress    device_address;  
  kvrAddress    client_address;  
  kvrAddress    base_station_id; 
  int32_t       request_connection; 
  int32_t       availability;    
  char          encryption_key[32];  
  char          reserved1[256];
  char          reserved2[256];
} kvrDeviceInfo;

typedef int32_t kvrDiscoveryHandle;


#define kvrAddressTypeFlag_ALL         0xff 
#define kvrAddressTypeFlag_BROADCAST   0x01 
#define kvrAddressTypeFlag_STORED      0x02 
kvrStatus WINAPI kvrDiscoveryGetDefaultAddresses(kvrAddress address_list[],
                                                 uint32_t address_list_size,
                                                 uint32_t *address_list_count,
                                                 uint32_t address_type_flags);

kvrStatus WINAPI kvrDiscoveryOpen(kvrDiscoveryHandle *handle);

kvrStatus WINAPI kvrDiscoveryClose(kvrDiscoveryHandle handle);

kvrStatus WINAPI kvrDiscoverySetAddresses(kvrDiscoveryHandle handle,
                                          const kvrAddress address_list[],
                                          uint32_t address_list_size);


kvrStatus WINAPI kvrDiscoveryStart(kvrDiscoveryHandle handle, uint32_t delay_ms,
                                   uint32_t timeout_ms);


kvrStatus WINAPI kvrDiscoveryStartEx(kvrDiscoveryHandle handle, uint32_t delay_ms,
                                   uint32_t timeout_ms, int add_stored);

kvrStatus WINAPI kvrDiscoveryGetResults(kvrDiscoveryHandle handle,
                                        kvrDeviceInfo *device_info);

kvrStatus WINAPI kvrDiscoveryStoreDevices(const kvrDeviceInfo device_info_list[],
                                          uint32_t device_info_list_size);


kvrStatus WINAPI kvrDiscoveryClearDevicesAtExit(int onoff);

kvrStatus WINAPI kvrDiscoverySetPassword(kvrDeviceInfo *device_info,
                                         const char *password);

kvrStatus WINAPI kvrDiscoverySetEncryptionKey(kvrDeviceInfo *device_info,
                                              const char *key);


kvrStatus WINAPI kvrDeviceGetServiceStatusText(const kvrDeviceInfo *device_info,
                                               char *buffer,
                                               uint32_t buffer_size);

kvrStatus WINAPI kvrDeviceGetServiceStatus(const kvrDeviceInfo *device_info,
                                           int32_t *state, int32_t *start_info);

kvrStatus WINAPI kvrGetErrorText(kvrStatus error, char *buffer,
                                 uint32_t buffer_size);

uint16_t WINAPI kvrGetVersion(void);

kvrStatus WINAPI kvrStringFromAddress(char *buffer, uint32_t buffer_size,
                                      const kvrAddress *address);

kvrStatus WINAPI kvrAddressFromString(int32_t address_type, kvrAddress *address,
                                      const char *address_string);

kvrStatus WINAPI kvrWlanGetSecurityText(char *security_string,
                                        uint32_t security_string_size,
                                        uint32_t capability,
                                        uint32_t type_wpa,
                                        const kvrCipherInfoElement *wpa_info,
                                        const kvrCipherInfoElement *rsn_info);

kvrStatus WINAPI kvrNetworkGenerateWepKeys(const char *pass_phrase,
                                           char *key64_1,
                                           char *key64_2,
                                           char *key64_3,
                                           char *key64_4,
                                           char *key128);

kvrStatus WINAPI kvrNetworkGenerateWpaKeys(const char *pass_phrase,
                                           const char *ssid,
                                           char *key);

void WINAPI kvrInitializeLibrary(void);


void WINAPI kvrUnloadLibrary(void);


kvrStatus WINAPI kvrServiceQuery(int *status);

kvrStatus WINAPI kvrServiceStart(int *status);

kvrStatus WINAPI kvrServiceStop(int *status);


#ifdef __cplusplus
}
#endif


#endif