scottk/wlan-docs
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/wlan-docs.git synced 2025-11-05 21:28:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

GitBook: [#1] No subject

Browse Source
This commit is contained in:
Jaspreet Sachdev
2022-09-22 13:52:42 +00:00
committed by gitbook-bot
parent 97caf995c6
commit a3dea0eaea
254 changed files with 27406 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
developer-resources/sdk-kafka/README.md Normal file
View File

@@ -0,0 +1,13 @@
# SDK KAFKA
The current release has the following Kafka topics:
* connection 
* device\_event\_queue 
* device\_telemetry
* healthcheck
* provisioning\_change
* service\_events
* state
* wifiscan

400
developer-resources/sdk-kafka/connection.md Normal file
View File

@@ -0,0 +1,400 @@
# Connection
Here are the current messages related to connection topic:
## Ping Message
```json
{
"system": {
"id": 1637414624750592500,
"host": "https://owgw-owgw:17002"
},
"payload": {
"ping": {
"compatible": "cig_wf194c4",
"connectionIp": "f40b9fe78d3d@10.10.10.48:35510",
"firmware": "OpenWrt 21.02-SNAPSHOT r16399+136-c67509efd7 / TIP-v2.6.0-rc4-eebe021",
"locale": "US",
"serialNumber": "f40b9fe78d3d",
"timestamp": 1656513408
}
}
}
```
## Capability Message
```json
{
"system": {
"id": 1637414624750592500,
"host": "https://owgw-owgw:17002"
},
"payload": {
"capabilities": {
"compatible": "cig_wf196",
"label_macaddr": "82:4f:81:60:11:e4",
"macaddr": {
"lan": "82:4f:81:60:11:e5",
"wan": "82:4f:81:60:11:e4"
},
"model": "CIG WF196",
"network": {
"lan": [
"eth1"
],
"wan": [
"eth0"
]
},
"platform": "ap",
"switch": {
"switch0": {
"enable": false,
"reset": false
}
},
"wifi": {
"platform/soc/c000000.wifi1": {
"band": [
"5G"
],
"channels": [
36,
40,
44,
48,
52,
56,
60,
64,
100,
104,
108,
112,
116,
120,
124,
128,
132,
136,
140,
144,
149,
153,
157,
161,
165
],
"dfs_channels": [
52,
56,
60,
64,
100,
104,
108,
112,
116,
120,
124,
128,
132,
136,
140,
144
],
"frequencies": [
5180,
5200,
5220,
5240,
5260,
5280,
5300,
5320,
5500,
5520,
5540,
5560,
5580,
5600,
5620,
5640,
5660,
5680,
5700,
5720,
5745,
5765,
5785,
5805,
5825
],
"he_mac_capa": [
13,
39448,
4160
],
"he_phy_capa": [
24604,
34892,
56191,
40067,
3073,
0
],
"ht_capa": 6639,
"htmode": [
"HT20",
"HT40",
"VHT20",
"VHT40",
"VHT80",
"VHT80+80",
"VHT160",
"HE20",
"HE40",
"HE80",
"HE160",
"HE80+80"
],
"rx_ant": 240,
"tx_ant": 240,
"vht_capa": 1939601914
},
"platform/soc/c000000.wifi1+1": {
"band": [
"2G"
],
"channels": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"frequencies": [
2412,
2417,
2422,
2427,
2432,
2437,
2442,
2447,
2452,
2457,
2462
],
"he_mac_capa": [
13,
39448,
4160
],
"he_phy_capa": [
24578,
34892,
50047,
40067,
3073,
0
],
"ht_capa": 6639,
"htmode": [
"HT20",
"HT40",
"VHT20",
"VHT40",
"VHT80",
"HE20",
"HE40"
],
"rx_ant": 15,
"tx_ant": 15,
"vht_capa": 1939569042
},
"soc/20000000.pci/pci0000:00/0000:00:00.0/0000:01:00.0": {
"band": [
"6G"
],
"channels": [
1,
5,
9,
13,
17,
21,
25,
29,
33,
37,
41,
45,
49,
53,
57,
61,
65,
69,
73,
77,
81,
85,
89,
93,
97,
101,
105,
109,
113,
117,
121,
125,
129,
133,
137,
141,
145,
149,
153,
157,
161,
165,
169,
173,
177,
181,
185,
189,
193,
197,
201,
205,
209,
213,
217,
221,
225,
229,
233
],
"frequencies": [
5955,
5975,
5995,
6015,
6035,
6055,
6075,
6095,
6115,
6135,
6155,
6175,
6195,
6215,
6235,
6255,
6275,
6295,
6315,
6335,
6355,
6375,
6395,
6415,
6435,
6455,
6475,
6495,
6515,
6535,
6555,
6575,
6595,
6615,
6635,
6655,
6675,
6695,
6715,
6735,
6755,
6775,
6795,
6815,
6835,
6855,
6875,
6895,
6915,
6935,
6955,
6975,
6995,
7015,
7035,
7055,
7075,
7095,
7115
],
"he_mac_capa": [
13,
39448,
4160
],
"he_phy_capa": [
24604,
34892,
56319,
40067,
3089,
0
],
"htmode": [
"HE20",
"HE40",
"HE80",
"HE160",
"HE80+80"
],
"rx_ant": 15,
"tx_ant": 15
}
}
},
"connectionIp": "824f816011e4@10.10.11.185:50412",
"firmware": "OpenWrt 21.02-SNAPSHOT r16399+136-c67509efd7 / TIP-v2.6.0-rc4-eebe021",
"locale": "US",
"serial": "824f816011e4",
"timestamp": 1656516572,
"uuid": 1
}
}
```
## Disconnection Message
```json
{
"system": {
"id": 1637414624750592500,
"host": "https://owgw-owgw:17002"
},
"payload": {
"disconnection": {
"serialNumber": "824f816011e4",
"timestamp": 1656516851
}
}
}
```

45
developer-resources/sdk-kafka/device-event-queue.md Normal file
View File

@@ -0,0 +1,45 @@
# Device Event Queue
## Single Event (DHCP Example)
```json
{
"system": {
"id": 1637414624750592500,
"host": "https://owgw-owgw:17002"
},
"payload": {
"events": {
"dhcp": []
},
"serial": "c44bd1005b30",
"status": {
"error": 0,
"text": "Success"
},
"uuid": 1656049674
}
```
## Multiple Events
```json
{
"system": {
"id": 1637414624750592500,
"host": "https://owgw-owgw:17002"
},
"payload": {
"events": {
"dhcp": [],
"wifi": []
},
"serial": "0000c1018812",
"status": {
"error": 0,
"text": "Success"
},
"uuid": 1657087470
}
}
```

2
developer-resources/sdk-kafka/device-telemetry.md Normal file
View File

@@ -0,0 +1,2 @@
# Device Telemetry

75
developer-resources/sdk-kafka/healthcheck.md Normal file
View File

@@ -0,0 +1,75 @@
# Healthcheck
## Unit
```json
{
"system": {
"id": 1637414624750592500,
"host": "https://owgw-owgw:17002"
},
"payload": {
"data": {
"unit": {
"memory": 20
}
},
"sanity": 100,
"serial": "903cb39d69c0",
"timestamp": 1657200271,
"uuid": 1657194597
}
}
```
## Interfaces + Unit
```json
{
"system": {
"id": 1637414624750592500,
"host": "https://owgw-owgw:17002"
},
"payload": {
"data": {
"interfaces": {
"up1v100": {
"dhcp": false,
"location": "/interfaces/1",
"warning": [
"DHCP did not offer any leases"
]
},
"up2v125": {
"dhcp": false,
"location": "/interfaces/2",
"warning": [
"DHCP did not offer any leases"
]
},
"up3v200": {
"dhcp": false,
"location": "/interfaces/3",
"warning": [
"DHCP did not offer any leases"
]
},
"up4v150": {
"dhcp": false,
"location": "/interfaces/4",
"warning": [
"DHCP did not offer any leases"
]
}
},
"unit": {
"memory": 20
}
},
"sanity": 43,
"serial": "0006aee53b84",
"timestamp": 1657200310,
"uuid": 1657198335
}
}
```

51
developer-resources/sdk-kafka/provisioning-change.md Normal file
View File

@@ -0,0 +1,51 @@
# Provisioning Change
## Venue Updates
```json
{
"system": {
"id": 1637211374533410000,
"host": "https://owprov-owprov:17005"
},
"payload": {
"ObjectType": "Venue",
"boards": [],
"children": [],
"configurations": [],
"contacts": [],
"created": 1656163862,
"description": "For testing Purposes through Automation",
"design": "",
"deviceConfiguration": [],
"deviceRules": {
"firmwareUpgrade": "inherit",
"rcOnly": "inherit",
"rrm": "inherit"
},
"devices": [],
"entity": "6a657863-9940-4303-ac68-4cc10d3078ec",
"id": "22146613-13f8-47a4-b21d-c2c2d214a695",
"location": "",
"managementPolicies": [],
"managementPolicy": "",
"managementRoles": [],
"maps": [],
"modified": 1656163862,
"name": "Testing Prov",
"notes": [
{
"created": 1656163862,
"createdBy": "tip@ucentral.com",
"note": "For testing Purposes"
}
],
"parent": "",
"sourceIP": [],
"tags": [],
"topology": [],
"variables": []
}
}
```

27
developer-resources/sdk-kafka/service-events.md Normal file
View File

@@ -0,0 +1,27 @@
# Service Events
## Keep-alive
This message is sent by all SDK micro-services.
```json
{
"event": "keep-alive",
"id": 1651799646949140500,
"key": "c34b2bcafc78460025740e82922dc43ccb41d40d8d474e909a4b7065005e595e",
"privateEndPoint": "https://owanalytics-owanalytics:17009",
"publicEndPoint": "https://analytics-qa01.cicd.lab.wlan.tip.build:16009",
"type": "owanalytics",
"version": "2.6.0(69) - v2.6.0-RC3"
}
```
## Remove Token
```json
{
"event": "remove-token",
"id": 1637312489719148300,
"token": "0a6cdf595818e6da496c11a6794a6084b456425fa87181e1d350175096729f6a"
}
```

498
developer-resources/sdk-kafka/state.md Normal file
View File

@@ -0,0 +1,498 @@
# State
## State
```json
{
"system": {
"id": 1637414624750592500,
"host": "https://owgw-owgw:17002"
},
"payload": {
"serial": "50987100327b",
"state": {
"interfaces": [
{
"clients": [
{
"ipv6_addresses": [
"fe80:0:0:0:6f0:21ff:fe76:cab6"
],
"mac": "04:f0:21:76:ca:b6",
"ports": [
"wlan0"
]
},
{
"ipv4_addresses": [
"172.16.0.1"
],
"ipv6_addresses": [
"fe80:0:0:0:9e69:b4ff:fe60:e5f4"
],
"mac": "9c:69:b4:60:e5:f4",
"ports": [
"eth0"
]
}
],
"counters": {
"collisions": 0,
"multicast": 37,
"rx_bytes": 195056,
"rx_dropped": 0,
"rx_errors": 0,
"rx_packets": 1061,
"tx_bytes": 367918,
"tx_dropped": 0,
"tx_errors": 0,
"tx_packets": 1102
},
"dns_servers": [
"8.8.8.8"
],
"ipv4": {
"addresses": [
"172.16.56.202/16"
],
"dhcp_server": "172.16.0.1",
"leasetime": 600
},
"location": "/interfaces/0",
"name": "up0v0",
"ssids": [
{
"associations": [
{
"ack_signal": 0,
"ack_signal_avg": 0,
"bssid": "50:98:71:00:32:7a",
"connected": 769,
"inactive": 13,
"rssi": -49,
"rx_bytes": 7385,
"rx_duration": 9828,
"rx_packets": 56,
"rx_rate": {
"bitrate": 6000,
"chwidth": 20
},
"station": "04:f0:21:76:ca:b6",
"tid_stats": [
{
"rx_msdu": 21,
"tx_msdu": 19,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0,
"txq_stats": {
"backlog_bytes": 0,
"backlog_packets": 0,
"collisions": 0,
"drops": 0,
"ecn_marks": 0,
"flows": 19,
"overlimit": 0,
"tx_bytes": 5549,
"tx_packets": 19
}
},
{
"rx_msdu": 0,
"tx_msdu": 0,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0,
"txq_stats": {
"backlog_bytes": 0,
"backlog_packets": 0,
"collisions": 0,
"drops": 0,
"ecn_marks": 0,
"flows": 0,
"overlimit": 0,
"tx_bytes": 0,
"tx_packets": 0
}
},
{
"rx_msdu": 0,
"tx_msdu": 0,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0,
"txq_stats": {
"backlog_bytes": 0,
"backlog_packets": 0,
"collisions": 0,
"drops": 0,
"ecn_marks": 0,
"flows": 0,
"overlimit": 0,
"tx_bytes": 0,
"tx_packets": 0
}
},
{
"rx_msdu": 0,
"tx_msdu": 0,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0,
"txq_stats": {
"backlog_bytes": 0,
"backlog_packets": 0,
"collisions": 0,
"drops": 0,
"ecn_marks": 0,
"flows": 0,
"overlimit": 0,
"tx_bytes": 0,
"tx_packets": 0
}
},
{
"rx_msdu": 0,
"tx_msdu": 0,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0,
"txq_stats": {
"backlog_bytes": 0,
"backlog_packets": 0,
"collisions": 0,
"drops": 0,
"ecn_marks": 0,
"flows": 0,
"overlimit": 0,
"tx_bytes": 0,
"tx_packets": 0
}
},
{
"rx_msdu": 0,
"tx_msdu": 0,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0,
"txq_stats": {
"backlog_bytes": 0,
"backlog_packets": 0,
"collisions": 0,
"drops": 0,
"ecn_marks": 0,
"flows": 0,
"overlimit": 0,
"tx_bytes": 0,
"tx_packets": 0
}
},
{
"rx_msdu": 12,
"tx_msdu": 0,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0,
"txq_stats": {
"backlog_bytes": 0,
"backlog_packets": 0,
"collisions": 0,
"drops": 0,
"ecn_marks": 0,
"flows": 0,
"overlimit": 0,
"tx_bytes": 0,
"tx_packets": 0
}
},
{
"rx_msdu": 0,
"tx_msdu": 0,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0,
"txq_stats": {
"backlog_bytes": 0,
"backlog_packets": 0,
"collisions": 0,
"drops": 0,
"ecn_marks": 0,
"flows": 0,
"overlimit": 0,
"tx_bytes": 0,
"tx_packets": 0
}
},
{
"rx_msdu": 0,
"tx_msdu": 0,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0,
"txq_stats": {
"backlog_bytes": 0,
"backlog_packets": 0,
"collisions": 0,
"drops": 0,
"ecn_marks": 0,
"flows": 0,
"overlimit": 0,
"tx_bytes": 0,
"tx_packets": 0
}
},
{
"rx_msdu": 0,
"tx_msdu": 0,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0,
"txq_stats": {
"backlog_bytes": 0,
"backlog_packets": 0,
"collisions": 0,
"drops": 0,
"ecn_marks": 0,
"flows": 0,
"overlimit": 0,
"tx_bytes": 0,
"tx_packets": 0
}
},
{
"rx_msdu": 0,
"tx_msdu": 0,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0,
"txq_stats": {
"backlog_bytes": 0,
"backlog_packets": 0,
"collisions": 0,
"drops": 0,
"ecn_marks": 0,
"flows": 0,
"overlimit": 0,
"tx_bytes": 0,
"tx_packets": 0
}
},
{
"rx_msdu": 0,
"tx_msdu": 0,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0,
"txq_stats": {
"backlog_bytes": 0,
"backlog_packets": 0,
"collisions": 0,
"drops": 0,
"ecn_marks": 0,
"flows": 0,
"overlimit": 0,
"tx_bytes": 0,
"tx_packets": 0
}
},
{
"rx_msdu": 0,
"tx_msdu": 0,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0,
"txq_stats": {
"backlog_bytes": 0,
"backlog_packets": 0,
"collisions": 0,
"drops": 0,
"ecn_marks": 0,
"flows": 0,
"overlimit": 0,
"tx_bytes": 0,
"tx_packets": 0
}
},
{
"rx_msdu": 0,
"tx_msdu": 0,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0,
"txq_stats": {
"backlog_bytes": 0,
"backlog_packets": 0,
"collisions": 0,
"drops": 0,
"ecn_marks": 0,
"flows": 0,
"overlimit": 0,
"tx_bytes": 0,
"tx_packets": 0
}
},
{
"rx_msdu": 0,
"tx_msdu": 0,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0,
"txq_stats": {
"backlog_bytes": 0,
"backlog_packets": 0,
"collisions": 0,
"drops": 0,
"ecn_marks": 0,
"flows": 0,
"overlimit": 0,
"tx_bytes": 0,
"tx_packets": 0
}
},
{
"rx_msdu": 0,
"tx_msdu": 0,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0,
"txq_stats": {
"backlog_bytes": 0,
"backlog_packets": 0,
"collisions": 0,
"drops": 0,
"ecn_marks": 0,
"flows": 0,
"overlimit": 0,
"tx_bytes": 0,
"tx_packets": 0
}
},
{
"rx_msdu": 0,
"tx_msdu": 4,
"tx_msdu_failed": 0,
"tx_msdu_retries": 0
}
],
"tx_bytes": 5798,
"tx_duration": 8121,
"tx_failed": 0,
"tx_packets": 23,
"tx_rate": {
"bitrate": 180000,
"chwidth": 40,
"ht": true,
"mcs": 12,
"sgi": true
},
"tx_retries": 0
}
],
"bssid": "50:98:71:00:32:7a",
"iface": "wlan0",
"location": "/interfaces/0/ssids/0",
"mode": "ap",
"phy": "platform/soc/a000000.wifi",
"radio": {
"$ref": "#/radios/0"
},
"ssid": "tls_ssid_wpa2"
},
{
"bssid": "50:98:71:00:32:79",
"iface": "wlan1",
"location": "/interfaces/0/ssids/0",
"mode": "ap",
"phy": "platform/soc/a800000.wifi",
"radio": {
"$ref": "#/radios/1"
},
"ssid": "tls_ssid_wpa2"
}
],
"uptime": 5592
},
{
"counters": {
"collisions": 0,
"multicast": 0,
"rx_bytes": 0,
"rx_dropped": 0,
"rx_errors": 0,
"rx_packets": 0,
"tx_bytes": 0,
"tx_dropped": 0,
"tx_errors": 0,
"tx_packets": 0
},
"ipv4": {
"addresses": [
"192.168.1.1/16"
]
},
"location": "/interfaces/1",
"name": "down1v0",
"uptime": 2115
}
],
"link-state": {
"downstream": {
"eth1": {
"carrier": 0
}
},
"upstream": {
"eth0": {
"carrier": 1,
"duplex": "full",
"speed": 1000
}
}
},
"lldp-peers": {
"downstream": {},
"upstream": {
"eth0": [
{
"capability": [
"Bridge",
"Router",
"Wlan"
],
"description": "OpenWrt 21.02-SNAPSHOT @ 00c115194c15",
"mac": "00:c1:15:19:4c:15",
"name": "CIG WF194C",
"port": "eth0"
}
]
}
},
"radios": [
{
"active_ms": 1250435,
"busy_ms": 92944,
"channel": 6,
"channel_width": "40",
"noise": -99,
"phy": "platform/soc/a000000.wifi",
"receive_ms": 44474,
"transmit_ms": 3831,
"tx_power": 30
},
{
"active_ms": 1248675,
"busy_ms": 7493,
"channel": 100,
"channel_width": "80",
"noise": -108,
"phy": "platform/soc/a800000.wifi",
"receive_ms": 3991,
"transmit_ms": 4124,
"tx_power": 24
}
],
"unit": {
"load": [
0.103517,
0.098634,
0.107424
],
"localtime": 1657201798,
"memory": {
"buffered": 6983680,
"cached": 19980288,
"free": 141684736,
"total": 254537728
},
"uptime": 5748
},
"version": 1
},
"uuid": 1657200535
}
}
```

2348
developer-resources/sdk-kafka/wifi-scan.md Normal file
View File

File diff suppressed because it is too large Load Diff