Skip to content
Snippets Groups Projects
Normal view Permalink
wifi.radio.md 18.1 KiB
Newer Older
  • Learn to ignore specific revisions
    • Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 
    # wifi.radio.<name> Schema

```
https://www.iopsys.eu/wifi.radio.json
```

WiFi Radio Object

| Custom Properties | Additional Properties |
| ----------------- | --------------------- |
| Forbidden         | Forbidden             |

# wifi.radio.<name>

| List of Methods             |
| --------------------------- |
    Jakob Olsson's avatar
    gitlab-ci: add tests for new functions, update docs and schemas  
    Jakob Olsson committed
    17 
    | [add_iface](#add_iface)     | Method | wifi.radio.<name> (this schema) |
    Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    18 
    | [autochannel](#autochannel) | Method | wifi.radio.<name> (this schema) |
    Jakob Olsson's avatar
    gitlab-ci: add tests for new functions, update docs and schemas  
    Jakob Olsson committed
    19 
    | [del_iface](#del_iface)     | Method | wifi.radio.<name> (this schema) |
    Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    20 21 22 23 24 25 
    | [get](#get)                 | Method | wifi.radio.<name> (this schema) |
| [scan](#scan)               | Method | wifi.radio.<name> (this schema) |
| [scanresults](#scanresults) | Method | wifi.radio.<name> (this schema) |
| [stats](#stats)             | Method | wifi.radio.<name> (this schema) |
| [status](#status)           | Method | wifi.radio.<name> (this schema) |
    Jakob Olsson's avatar
    gitlab-ci: add tests for new functions, update docs and schemas  
    Jakob Olsson committed
    26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 
    ## add_iface

`add_iface`

- type: `Method`

### add_iface Type

`object` with following properties:

| Property | Type   | Required |
| -------- | ------ | -------- |
| `input`  | object | Optional |
| `output` | object | Optional |

#### input

`input`

- is optional
- type: `object`

##### input Type

`object` with following properties:

| Property | Type    | Required |
| -------- | ------- | -------- |
| `args`   | object  | Optional |
| `config` | boolean | Optional |

#### args

`args`

- is optional
- type: `object`

##### args Type

`object` with following properties:

| Property | Type | Required |
| -------- | ---- | -------- |
| None     | None | None     |

#### config

`config`

- is optional
- type: `boolean`

##### config Type

`boolean`

### Ubus CLI Example

```
ubus call wifi.radio.<name> add_iface {"args":{},"config":true}
```

### JSONRPC Example

```json
{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "call",
  "params": ["<SID>", "wifi.radio.<name>", "add_iface", { "args": {}, "config": true }]
}
```

#### output

`output`

- is optional
- type: `object`

##### output Type

`object` with following properties:

| Property | Type | Required |
| -------- | ---- | -------- |
| None     | None | None     |

### Output Example

```json
{}
```
    Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 
    ## autochannel

`autochannel`

- type: `Method`

### autochannel Type

`object` with following properties:

| Property | Type   | Required |
| -------- | ------ | -------- |
| `input`  | object | Optional |
| `output` | object | Optional |

#### input

`input`

- is optional
- type: `object`

##### input Type

`object` with following properties:

| Property   | Type    | Required |
| ---------- | ------- | -------- |
| `algo`     | integer | Optional |
| `interval` | integer | Optional |
| `scans`    | integer | Optional |

#### algo

`algo`

- is optional
- type: `integer`

##### algo Type

`integer`

#### interval

`interval`

- is optional
- type: `integer`

##### interval Type

`integer`

#### scans

`scans`

- is optional
- type: `integer`

##### scans Type

`integer`

### Ubus CLI Example

```
    Jakob Olsson's avatar
    gitlab-ci: add tests for new functions, update docs and schemas  
    Jakob Olsson committed
    189 
    ubus call wifi.radio.<name> autochannel {"interval":42230905,"algo":-63796592,"scans":80502357}
    Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    190 191 192 193 194 195 196 197 198 199 200 201 202 
    ```

### JSONRPC Example

```json
{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "call",
  "params": [
    "<SID>",
    "wifi.radio.<name>",
    "autochannel",
    Jakob Olsson's avatar
    gitlab-ci: add tests for new functions, update docs and schemas  
    Jakob Olsson committed
    203 
        { "interval": 42230905, "algo": -63796592, "scans": 80502357 }
    Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 
      ]
}
```

#### output

##### wifi.radio.autochannel

Auto channel selection

`output`

- is optional
- type: `object`

##### output Type

`object` with following properties:

| Property      | Type    | Required     |
| ------------- | ------- | ------------ |
| `code`        | integer | **Required** |
| `new_channel` | oneOf   | **Required** |
| `status`      | string  | **Required** |

#### code

`code`

- is **required**
- type: `integer`

##### code Type

`integer`

#### new_channel

`new_channel`

- is **required**
- type: complex

##### new_channel Type

**One** of the following _conditions_ need to be fulfilled.

#### Condition 1

`integer`

- minimum value: `1`
- maximum value: `14`

#### Condition 2

`integer`

- minimum value: `32`
- maximum value: `200`

#### status

`status`

- is **required**
- type: `string`

##### status Type

`string`

### Output Example

```json
    Jakob Olsson's avatar
    gitlab-ci: add tests for new functions, update docs and schemas  
    Jakob Olsson committed
    279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 
    { "code": 2357742, "new_channel": 132, "status": "est in ad ex culpa" }
```

## del_iface

`del_iface`

- type: `Method`

### del_iface Type

`object` with following properties:

| Property | Type   | Required |
| -------- | ------ | -------- |
| `input`  | object | Optional |
| `output` | object | Optional |

#### input

`input`

- is optional
- type: `object`

##### input Type

`object` with following properties:

| Property | Type    | Required     |
| -------- | ------- | ------------ |
| `config` | boolean | Optional     |
| `ifname` | string  | **Required** |

#### config

`config`

- is optional
- type: `boolean`

##### config Type

`boolean`

#### ifname

`ifname`

- is **required**
- type: `string`

##### ifname Type

`string`

- maximum length: 16 characters

### Ubus CLI Example

```
ubus call wifi.radio.<name> del_iface {"ifname":"adipi","config":true}
```

### JSONRPC Example

```json
{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "call",
  "params": ["<SID>", "wifi.radio.<name>", "del_iface", { "ifname": "adipi", "config": true }]
}
```

#### output

`output`

- is optional
- type: `object`

##### output Type

`object` with following properties:

| Property | Type | Required |
| -------- | ---- | -------- |
| None     | None | None     |

### Output Example

```json
{}
    Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 
    ```

## get

`get`

- type: `Method`

### get Type

`object` with following properties:

| Property | Type   | Required |
| -------- | ------ | -------- |
| `input`  | object | Optional |
| `output` | object | Optional |

#### input

`input`

- is optional
- type: `object`

##### input Type

`object` with following properties:

| Property | Type   | Required |
| -------- | ------ | -------- |
| `param`  | string | Optional |

#### param

`param`

- is optional
- type: `string`

##### param Type

`string`

### Ubus CLI Example

```
    Jakob Olsson's avatar
    gitlab-ci: add tests for new functions, update docs and schemas  
    Jakob Olsson committed
    419 
    ubus call wifi.radio.<name> get {"param":"esse anim Duis minim laborum"}
    Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    420 421 422 423 424 
    ```

### JSONRPC Example

```json
    Jakob Olsson's avatar
    gitlab-ci: add tests for new functions, update docs and schemas  
    Jakob Olsson committed
    425 426 427 428 429 430 
    {
  "jsonrpc": "2.0",
  "id": 0,
  "method": "call",
  "params": ["<SID>", "wifi.radio.<name>", "get", { "param": "esse anim Duis minim laborum" }]
}
    Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 
    ```

#### output

`output`

- is optional
- type: `object`

##### output Type

`object` with following properties:

| Property | Type    | Required |
| -------- | ------- | -------- |
| `status` | integer | Optional |
| `values` | integer | Optional |

#### status

`status`

- is optional
- type: `integer`

##### status Type

`integer`

#### values

`values`

- is optional
- type: `integer`

##### values Type

`integer`

### Output Example

```json
    Jakob Olsson's avatar
    gitlab-ci: add tests for new functions, update docs and schemas  
    Jakob Olsson committed
    474 
    { "status": 7971921, "values": -22899543 }
    Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 
    ```

## scan

`scan`

- type: `Method`

### scan Type

`object` with following properties:

| Property | Type   | Required |
| -------- | ------ | -------- |
| `input`  | object | Optional |
| `output` | object | Optional |

#### input

`input`

- is optional
- type: `object`

##### input Type

`object` with following properties:

| Property  | Type   | Required |
| --------- | ------ | -------- |
| `bssid`   | string | Optional |
| `channel` | oneOf  | Optional |
| `ssid`    | string | Optional |

#### bssid

##### MAC Address

`bssid`

- is optional
- type: reference

##### bssid Type

`string`

- minimum length: 17 characters
- maximum length: 17 characters All instances must conform to this regular expression (test examples
  [here](<https://regexr.com/?expression=%5E(%5B0-9a-fA-F%5D%5B0-9a-fA-F%5D%3A)%7B5%7D%5B0-9a-fA-F%5D%5B0-9a-fA-F%5D%24>)):

```regex
^([0-9a-fA-F][0-9a-fA-F]:){5}[0-9a-fA-F][0-9a-fA-F]$
```

#### channel

`channel`

- is optional
- type: complex

##### channel Type

**One** of the following _conditions_ need to be fulfilled.

#### Condition 1

`integer`

- minimum value: `1`
- maximum value: `14`

#### Condition 2

`integer`

- minimum value: `32`
- maximum value: `200`

#### ssid

##### SSID

`ssid`

- is optional
- type: reference

##### ssid Type

`string`

- maximum length: 32 characters

### Ubus CLI Example

```
    Jakob Olsson's avatar
    gitlab-ci: add tests for new functions, update docs and schemas  
    Jakob Olsson committed
    573 
    ubus call wifi.radio.<name> scan {"ssid":"non","bssid":"Fe:e5:56:E7:78:bb","channel":11}
    Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    574 575 576 577 578 579 580 581 582 
    ```

### JSONRPC Example

```json
{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "call",
    Jakob Olsson's avatar
    gitlab-ci: add tests for new functions, update docs and schemas  
    Jakob Olsson committed
    583 
      "params": ["<SID>", "wifi.radio.<name>", "scan", { "ssid": "non", "bssid": "Fe:e5:56:E7:78:bb", "channel": 11 }]
    Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 
    }
```

#### output

Trigger a scan

`output`

- is optional
- type: `object`

##### output Type

`object` with following properties:

| Property | Type | Required |
| -------- | ---- | -------- |
| None     | None | None     |

### Output Example

```json
{}
```

## scanresults

`scanresults`

- type: `Method`

### scanresults Type

`object` with following properties:

| Property | Type   | Required |
| -------- | ------ | -------- |
| `input`  | object | Optional |
    Jakob Olsson's avatar
    gitlab-ci: add tests for new functions, update docs and schemas  
    Jakob Olsson committed
    623 
    | `output` | oneOf  | Optional |
    Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 
    
#### input

`input`

- is optional
- type: `object`

##### input Type

`object` with following properties:

| Property | Type | Required |
| -------- | ---- | -------- |
| None     | None | None     |

### Ubus CLI Example

```
ubus call wifi.radio.<name> scanresults {}
```

### JSONRPC Example

```json
{ "jsonrpc": "2.0", "id": 0, "method": "call", "params": ["<SID>", "wifi.radio.<name>", "scanresults", {}] }
```

#### output

Show scan results

`output`

- is optional
    Jakob Olsson's avatar
    gitlab-ci: add tests for new functions, update docs and schemas  
    Jakob Olsson committed
    659 
    - type: complex
    Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    660 661 662 
    
##### output Type
    Jakob Olsson's avatar
    gitlab-ci: add tests for new functions, update docs and schemas  
    Jakob Olsson committed
    663 664 665 666 667 668 
    **One** of the following _conditions_ need to be fulfilled.

#### Condition 1

#### Condition 2
    Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    669 670 
    `object` with following properties:
    Jakob Olsson's avatar
    gitlab-ci: add tests for new functions, update docs and schemas  
    Jakob Olsson committed
    671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 
    | Property           | Type    | Required     |
| ------------------ | ------- | ------------ |
| `band`             | string  | **Required** |
| `bssid`            | string  | **Required** |
| `encryption`       | string  | **Required** |
| `load_available`   | integer | **Required** |
| `load_stas`        | integer | **Required** |
| `load_utilization` | integer | **Required** |
| `rssi`             | integer | **Required** |
| `ssid`             | string  | **Required** |

#### band

##### WiFi Band

`band`

- is **required**
- type: reference

##### band Type

`string`

The value of this property **must** be equal to one of the [known values below](#-known-values).

##### band Known Values

| Value |
| ----- |
| 2GHz  |
| 5GHz  |

#### bssid

##### MAC Address

`bssid`

- is **required**
- type: reference

##### bssid Type

`string`

- minimum length: 17 characters
- maximum length: 17 characters All instances must conform to this regular expression (test examples
  [here](<https://regexr.com/?expression=%5E(%5B0-9a-fA-F%5D%5B0-9a-fA-F%5D%3A)%7B5%7D%5B0-9a-fA-F%5D%5B0-9a-fA-F%5D%24>)):

```regex
^([0-9a-fA-F][0-9a-fA-F]:){5}[0-9a-fA-F][0-9a-fA-F]$
```

#### encryption

`encryption`

- is **required**
- type: `string`

##### encryption Type

`string`

#### load_available

`load_available`

- is **required**
- type: `integer`

##### load_available Type

`integer`

- minimum value: `0`

#### load_stas

`load_stas`

- is **required**
- type: `integer`

##### load_stas Type

`integer`

- minimum value: `0`

#### load_utilization

`load_utilization`

- is **required**
- type: `integer`

##### load_utilization Type

`integer`

- minimum value: `0`
- maximum value: `100`

#### rssi

##### RSSI

`rssi`

- is **required**
- type: reference

##### rssi Type

`integer`

- minimum value: `-128`
- maximum value: `0`

#### ssid

##### SSID

`ssid`

- is **required**
- type: reference

##### ssid Type

`string`

- maximum length: 32 characters
    Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    806 807 808 809 
    
### Output Example

```json
    Jakob Olsson's avatar
    gitlab-ci: add tests for new functions, update docs and schemas  
    Jakob Olsson committed
    810 811 812 813 814 815 816 817 818 819 820 821 822 
    {
  "ssid": "sit mi",
  "bssid": "eF:96:af:66:13:4D",
  "encryption": "labore velit",
  "band": "2GHz",
  "rssi": -6,
  "load_stas": 17584500,
  "load_utilization": 65,
  "load_available": 75311380,
  "standard": 22195874,
  "bandwidth": "et ullamco",
  "channel": 48960927
}
    Jakob Olsson's avatar
    add CI pipeline tests
    Jakob Olsson committed
    823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 
    ```

## stats

`stats`

- type: `Method`

### stats Type

`object` with following properties:

| Property | Type   | Required |
| -------- | ------ | -------- |
| `input`  | object | Optional |
| `output` | object | Optional |

#### input

`input`

- is optional
- type: `object`

##### input Type

`object` with following properties:

| Property | Type | Required |
| -------- | ---- | -------- |
| None     | None | None     |

### Ubus CLI Example

```
ubus call wifi.radio.<name> stats {}
```

### JSONRPC Example

```json
{ "jsonrpc": "2.0", "id": 0, "method": "call", "params": ["<SID>", "wifi.radio.<name>", "stats", {}] }
```

#### output

##### wifi.radio.iface

Radio statistics

`output`

- is optional
- type: `object`

##### output Type

`object` with following properties:

| Property               | Type    | Required     |
| ---------------------- | ------- | ------------ |
| `rx_bytes`             | integer | **Required** |
| `rx_dropped_packets`   | integer | **Required** |
| `rx_error_packets`     | integer | **Required** |
| `rx_fcs_error_packets` | integer | **Required** |
| `rx_packets`           | integer | **Required** |
| `tx_bytes`             | integer | **Required** |
| `tx_dropped_packets`   | integer | **Required** |
| `tx_error_packets`     | integer | **Required** |
| `tx_packets`           | integer | **Required** |

#### rx_bytes

`rx_bytes`

- is **required**
- type: reference

##### rx_bytes Type

`integer`

- minimum value: `0`

#### rx_dropped_packets

`rx_dropped_packets`

- is **required**
- type: reference

##### rx_dropped_packets Type

`integer`

- minimum value: `0`

#### rx_error_packets

`rx_error_packets`

- is **required**
- type: reference

##### rx_error_packets Type

`integer`

- minimum value: `0`

#### rx_fcs_error_packets

`rx_fcs_error_packets`

- is **required**
- type: reference

##### rx_fcs_error_packets Type

`integer`

- minimum value: `0`

#### rx_packets

`rx_packets`

- is **required**
- type: reference

##### rx_packets Type

`integer`

- minimum value: `0`

#### tx_bytes

`tx_bytes`

- is **required**
- type: reference

##### tx_bytes Type

`integer`

- minimum value: `0`

#### tx_dropped_packets

`tx_dropped_packets`

- is **required**
- type: reference

##### tx_dropped_packets Type

`integer`

- minimum value: `0`

#### tx_error_packets

`tx_error_packets`

- is **required**
- type: reference

##### tx_error_packets Type

`integer`

- minimum value: `0`

#### tx_packets

`tx_packets`
    Show full blame