BltTofApi
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
bta_discovery.h
Go to the documentation of this file.
1 
20 #ifndef BTA_DISCOVERY_H_INCLUDED
21 #define BTA_DISCOVERY_H_INCLUDED
22 
23 
25 typedef enum BTA_DeviceType {
26  // Generic
27  BTA_DeviceTypeGenericEth = 0x0001,
28  BTA_DeviceTypeGenericP100 = 0x0002,
29  BTA_DeviceTypeGenericUart = 0x0003,
30  BTA_DeviceTypeGenericBltstream = 0x000f,
31 
32  // Etherned products
33  BTA_DeviceTypeArgos3dP310 = 0x9ba6,
34  BTA_DeviceTypeArgos3dP320 = 0xb320,
35  BTA_DeviceTypeSentisTofP510 = 0x5032,
36  BTA_DeviceTypeSentisTofM100 = 0xa9c1,
37  BTA_DeviceTypeTimUp19kS3Eth = 0x795c,
38  BTA_DeviceTypeSentisTofP509 = 0x4859,
39 
40  // P100 products
41  BTA_DeviceTypeArgos3dP100 = 0xa3c4,
42  BTA_DeviceTypeTimUp19kS3Spartan6 = 0x13ab,
43 
44  // UART products
45  BTA_DeviceTypeEPC610TofModule = 0x7a3d,
47 
48 
50 typedef struct BTA_DiscoveryConfig {
52 
53  uint8_t *broadcastIpAddr;
55  uint16_t broadcastPort;
56  uint8_t *callbackIpAddr;
58  uint16_t callbackPort;
59 
60  uint8_t *uartPortName;
61  int32_t uartBaudRate;
62  uint8_t uartDataBits;
63  uint8_t uartStopBits;
64  uint8_t uartParity;
67 
68 
70 typedef struct BTA_DeviceInfo {
72  uint8_t *productOrderNumber;
73  uint32_t serialNumber;
77  uint32_t mode0;
78  uint32_t status;
79  uint32_t uptime;
80 
81  uint8_t *deviceMacAddr;
82  uint32_t deviceMacAddrLen;
83  uint8_t *deviceIpAddr;
84  uint32_t deviceIpAddrLen;
85  uint8_t *subnetMask;
86  uint32_t subnetMaskLen;
87  uint8_t *gatewayIpAddr;
88  uint32_t gatewayIpAddrLen;
89  uint16_t tcpControlPort;
90  uint16_t tcpDataPort;
91  uint8_t *udpDataIpAddr;
92  uint32_t udpDataIpAddrLen;
93  uint16_t udpDataPort;
94  uint16_t udpControlPort;
96 
97 
102 typedef void (BTA_CALLCONV *FN_BTA_DeviceFound)(BTA_Handle handle, BTA_DeviceInfo *deviceInfo);
103 
104 
105 #endif
uint32_t udpDataIpAddrLen
The length in bytes of udpDataIpAddr.
Definition: bta_discovery.h:92
uint32_t gatewayIpAddrLen
The length in bytes of gatewayIpAddr.
Definition: bta_discovery.h:88
uint8_t * uartPortName
The port name of the UART to use (ASCII coded)
Definition: bta_discovery.h:60
uint8_t * deviceIpAddr
The IP address of the device.
Definition: bta_discovery.h:83
uint32_t deviceIpAddrLen
The length in bytes of deviceIpAddr.
Definition: bta_discovery.h:84
struct BTA_DeviceInfo BTA_DeviceInfo
This structure holds information about the device.
uint32_t deviceMacAddrLen
The length in bytes of deviceMacAddr.
Definition: bta_discovery.h:82
uint8_t * deviceMacAddr
The MAC address of the device.
Definition: bta_discovery.h:81
uint32_t uptime
The content of the device's uptime register.
Definition: bta_discovery.h:79
uint32_t firmwareVersionMajor
Firmware version major.
Definition: bta_discovery.h:74
uint32_t status
The content of the device's status register.
Definition: bta_discovery.h:78
uint32_t subnetMaskLen
The length in bytes of subnetMask.
Definition: bta_discovery.h:86
uint8_t uartTransmitterAddress
The source address for UART communications.
Definition: bta_discovery.h:65
BTA_DeviceType
All device types currently known to the SDK (Blt projects not included)
Definition: bta_discovery.h:25
void * BTA_Handle
The handle to hold the instance created by BTAopen.
Definition: bta.h:51
int32_t uartBaudRate
The UART baud rate.
Definition: bta_discovery.h:61
This structure is used to configure the process of device discovery.
Definition: bta_discovery.h:50
uint16_t udpDataPort
The UDP port of the data interface.
Definition: bta_discovery.h:93
uint8_t * productOrderNumber
String containing the PON (not including the serial number) (unique in combination with serial number...
Definition: bta_discovery.h:72
uint16_t tcpControlPort
The TCP port of the control interface.
Definition: bta_discovery.h:89
BTA_DeviceType deviceType
A special device type to look for, 0: Any.
Definition: bta_discovery.h:51
uint32_t mode0
The content of the device's primary mode register.
Definition: bta_discovery.h:77
BTA_DeviceType deviceType
Two-byte-id for a device or module (independent of hardware and software versions) ...
Definition: bta_discovery.h:71
uint32_t serialNumber
Serial number (unique in combination with PON)
Definition: bta_discovery.h:73
struct BTA_DiscoveryConfig BTA_DiscoveryConfig
This structure is used to configure the process of device discovery.
uint8_t callbackIpAddrLen
The length in bytes of callbackIpAddr.
Definition: bta_discovery.h:57
uint8_t uartStopBits
0: None, 1: One, 2: Two, 3: 1.5 stop bits
Definition: bta_discovery.h:63
uint8_t * gatewayIpAddr
The gateway IP address of the device.
Definition: bta_discovery.h:87
uint8_t * subnetMask
The subnet IP address of the device.
Definition: bta_discovery.h:85
uint8_t * callbackIpAddr
The UDP callback IP address, null: chosen automatically.
Definition: bta_discovery.h:56
uint16_t udpControlPort
The UDP port of the control interface.
Definition: bta_discovery.h:94
uint8_t broadcastIpAddrLen
The length in bytes of broadcastIpAddr.
Definition: bta_discovery.h:54
uint16_t callbackPort
The UDP port to listen for responses, 0: chosen automatically.
Definition: bta_discovery.h:58
uint32_t firmwareVersionMinor
Firmware version minor.
Definition: bta_discovery.h:75
uint16_t tcpDataPort
The TCP port of the data interface.
Definition: bta_discovery.h:90
uint8_t uartParity
0: None, 1: Odd, 2: Even, 3: Mark, 4: Space Parity
Definition: bta_discovery.h:64
uint8_t * udpDataIpAddr
The IP destination address of the UDP data stream.
Definition: bta_discovery.h:91
uint16_t broadcastPort
The UDP port to send the broadcast to, 0: 11003.
Definition: bta_discovery.h:55
uint8_t * broadcastIpAddr
The UDP broadcast IP address, null: 255.255.255.255.
Definition: bta_discovery.h:53
This structure holds information about the device.
Definition: bta_discovery.h:70
uint8_t uartDataBits
The number of UART data bits used.
Definition: bta_discovery.h:62
uint32_t firmwareVersionNonFunc
Firmware version non functional.
Definition: bta_discovery.h:76
typedef void(1 *FN_BTA_DeviceFound)(BTA_Handle handle
Callback function to report on a discovered device Do not call BTAfreeDeviceInfo on deviceInfo...