kvrDeviceInfo Struct Reference

Holds information about a discovered device. More...

#include <kvrlib.h>

Data Fields

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]
 

Detailed Description

Holds information about a discovered device.

The information in here is returned when a device is discovered. For a WLAN connected device, device_address and client_address are IP addresses, and base_station_id is the ethernet MAC address of the AP.

Depending on the "availability" flag, not all fields may be used. If "availability" includes the flag kvrAvailability_STORED the following fields are set: ean_hi, ean_lo, ser_no, device_address, request_connection, name and accessibility_pwd.

If the field "availability" includes the flag kvrAvailability_FOUND_BY_SCAN, the following fields are set: fw_major_ver, fw_minor_ver, fw_build_ver, usage, accessibility, host_name and client_address.

Examples:
example/c/kvrConnect.c.

Field Documentation

◆ accessibility

int32_t accessibility

◆ accessibility_pwd

char accessibility_pwd[256]

Accessibility password or empty.

Examples:
example/c/kvrConnect.c.

◆ availability

int32_t availability

The device availability. One or more kvrAvailability_xxx flags.

Examples:
example/c/kvrConnect.c.

◆ base_station_id

kvrAddress base_station_id

Unique ID of base station, if any.

◆ client_address

kvrAddress client_address

Address of connected client, if any.

Examples:
example/c/kvrConnect.c.

◆ device_address

kvrAddress device_address

Address of remote device.

Examples:
example/c/kvrConnect.c.

◆ ean_hi

uint32_t ean_hi

High part of EAN.

Examples:
example/c/kvrConnect.c.

◆ ean_lo

uint32_t ean_lo

Low part of EAN.

Examples:
example/c/kvrConnect.c.

◆ encryption_key

char encryption_key[32]

Encryption key.

◆ fw_build_ver

int32_t fw_build_ver

Firmware build version.

Examples:
example/c/kvrConnect.c.

◆ fw_major_ver

int32_t fw_major_ver

Major firmware version.

Examples:
example/c/kvrConnect.c.

◆ fw_minor_ver

int32_t fw_minor_ver

Minor firmware version.

Examples:
example/c/kvrConnect.c.

◆ host_name

char host_name[256]

DNS hostname or empty.

Examples:
example/c/kvrConnect.c.

◆ name

char name[256]

User-defined name.

Examples:
example/c/kvrConnect.c.

◆ request_connection

int32_t request_connection

Activate or deactivate a request for connection to a specified device. Activation means that the device will be connected to when it appears in the future.

◆ reserved1

char reserved1[256]

◆ reserved2

char reserved2[256]

◆ ser_no

uint32_t ser_no

Serial number.

Examples:
example/c/kvrConnect.c.

◆ struct_size

uint32_t struct_size

Size of struct, used for compatibility.

◆ usage

int32_t usage

The documentation for this struct was generated from the following file: