Schemas / I/O
rig.io.wifi
v1.4.0 · stable maturity: draft 4 fields 0 required
Fields
| Field | Type | Meaning | |
|---|---|---|---|
mode |
enumoff · ap · sta · ap-sta | optional | Optional. off, ap, sta, or ap-sta. Absent = off |
apSsid |
string | optional | Optional. Access-point name. Absent = the host default |
staSsid |
string | optional | Optional. Network to join when mode is sta or ap-sta. Absent = none |
channel |
integer1 – 14 | optional | Optional. 2.4 GHz channel 1-14. Absent = the interface default |
Wi-Fi radio mode for one interface. Format when present. The join password is host-only.
connected, the address, and RSSI are host cache. The STA password is not a field: a host may keep it in local storage and must not write it into the document.
JSON Schema
Resolves at https://rig.works/schemas/rig.io.wifi.schema.json —
raw file.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://rig.works/schemas/rig.io.wifi.schema.json",
"title": "rig.io.wifi",
"type": "object",
"additionalProperties": false,
"properties": {
"mode": {
"type": "string",
"enum": [
"off",
"ap",
"sta",
"ap-sta"
]
},
"apSsid": {
"$ref": "./_defs.schema.json#/$defs/string"
},
"staSsid": {
"$ref": "./_defs.schema.json#/$defs/string"
},
"channel": {
"type": "integer",
"minimum": 1,
"maximum": 14
}
},
"x-rig-maturity": "draft"
}