Skip to content

Wireless API

Wireless configuration classes.

WirelessConfig

WirelessConfig

Bases: UCISection

Wireless configuration manager.

Source code in src/wrtkit/wireless.py 
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
class WirelessConfig(UCISection):
    """Wireless configuration manager."""

    radios: List[WirelessRadio] = Field(default_factory=list)
    interfaces: List[WirelessInterface] = Field(default_factory=list)
    remote_policy: Optional[RemotePolicy] = None

    def __init__(self, **data: Any) -> None:
        super().__init__(**data)
        self._package = "wireless"
        self._section = ""
        self._section_type = ""

    def add_radio(self, radio: WirelessRadio) -> "WirelessConfig":
        """Add a radio and return self for chaining."""
        self.radios.append(radio)
        return self

    def add_interface(self, interface: WirelessInterface) -> "WirelessConfig":
        """Add an interface and return self for chaining."""
        self.interfaces.append(interface)
        return self

    def get_commands(self) -> List[UCICommand]:
        """Get all UCI commands for wireless configuration."""
        commands = []
        for radio in self.radios:
            commands.extend(radio.get_commands())
        for interface in self.interfaces:
            commands.extend(interface.get_commands())
        return commands

add_radio(radio)

Add a radio and return self for chaining.

Source code in src/wrtkit/wireless.py 
154
155
156
157
def add_radio(self, radio: WirelessRadio) -> "WirelessConfig":
    """Add a radio and return self for chaining."""
    self.radios.append(radio)
    return self

add_interface(interface)

Add an interface and return self for chaining.

Source code in src/wrtkit/wireless.py 
159
160
161
162
def add_interface(self, interface: WirelessInterface) -> "WirelessConfig":
    """Add an interface and return self for chaining."""
    self.interfaces.append(interface)
    return self

get_commands()

Get all UCI commands for wireless configuration.

Source code in src/wrtkit/wireless.py 
164
165
166
167
168
169
170
171
def get_commands(self) -> List[UCICommand]:
    """Get all UCI commands for wireless configuration."""
    commands = []
    for radio in self.radios:
        commands.extend(radio.get_commands())
    for interface in self.interfaces:
        commands.extend(interface.get_commands())
    return commands

WirelessRadio

WirelessRadio

Bases: UCISection

Represents a wireless radio configuration.

Source code in src/wrtkit/wireless.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class WirelessRadio(UCISection):
    """Represents a wireless radio configuration."""

    channel: Optional[int] = None
    htmode: Optional[str] = None
    country: Optional[str] = None
    disabled: Optional[bool] = None
    txpower: Optional[int] = None

    def __init__(self, radio_name: str, **data: Any) -> None:
        super().__init__(**data)
        self._package = "wireless"
        self._section = radio_name
        self._section_type = "wifi-device"

    # Immutable builder methods (composable)
    def with_channel(self, value: int) -> "WirelessRadio":
        """Set the wireless channel (returns new copy)."""
        return self.model_copy(update={"channel": value})

    def with_htmode(self, value: str) -> "WirelessRadio":
        """Set the HT mode (e.g., 'HT20', 'HT40', 'VHT80') (returns new copy)."""
        return self.model_copy(update={"htmode": value})

    def with_country(self, value: str) -> "WirelessRadio":
        """Set the country code (returns new copy)."""
        return self.model_copy(update={"country": value})

    def with_disabled(self, value: bool) -> "WirelessRadio":
        """Enable or disable the radio (returns new copy)."""
        return self.model_copy(update={"disabled": value})

    def with_txpower(self, value: int) -> "WirelessRadio":
        """Set the transmission power (returns new copy)."""
        return self.model_copy(update={"txpower": value})

with_channel(value)

Set the wireless channel (returns new copy).

Source code in src/wrtkit/wireless.py 
24
25
26
def with_channel(self, value: int) -> "WirelessRadio":
    """Set the wireless channel (returns new copy)."""
    return self.model_copy(update={"channel": value})

with_htmode(value)

Set the HT mode (e.g., 'HT20', 'HT40', 'VHT80') (returns new copy).

Source code in src/wrtkit/wireless.py 
28
29
30
def with_htmode(self, value: str) -> "WirelessRadio":
    """Set the HT mode (e.g., 'HT20', 'HT40', 'VHT80') (returns new copy)."""
    return self.model_copy(update={"htmode": value})

with_country(value)

Set the country code (returns new copy).

Source code in src/wrtkit/wireless.py 
32
33
34
def with_country(self, value: str) -> "WirelessRadio":
    """Set the country code (returns new copy)."""
    return self.model_copy(update={"country": value})

with_disabled(value)

Enable or disable the radio (returns new copy).

Source code in src/wrtkit/wireless.py 
36
37
38
def with_disabled(self, value: bool) -> "WirelessRadio":
    """Enable or disable the radio (returns new copy)."""
    return self.model_copy(update={"disabled": value})

with_txpower(value)

Set the transmission power (returns new copy).

Source code in src/wrtkit/wireless.py 
40
41
42
def with_txpower(self, value: int) -> "WirelessRadio":
    """Set the transmission power (returns new copy)."""
    return self.model_copy(update={"txpower": value})

WirelessInterface

WirelessInterface

Bases: UCISection

Represents a wireless interface configuration.

Source code in src/wrtkit/wireless.py 
 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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
class WirelessInterface(UCISection):
    """Represents a wireless interface configuration."""

    device: Optional[str] = None
    mode: Optional[str] = None
    network: Optional[str] = None
    ssid: Optional[str] = None
    encryption: Optional[str] = None
    key: Optional[str] = None
    ifname: Optional[str] = None
    mesh_id: Optional[str] = None
    mesh_fwding: Optional[bool] = None
    mcast_rate: Optional[int] = None
    ieee80211r: Optional[bool] = None
    ft_over_ds: Optional[bool] = None
    ft_psk_generate_local: Optional[bool] = None

    def __init__(self, iface_name: str, **data: Any) -> None:
        super().__init__(**data)
        self._package = "wireless"
        self._section = iface_name
        self._section_type = "wifi-iface"

    # Immutable builder methods (composable)
    def with_device(self, value: str) -> "WirelessInterface":
        """Set the radio device for this interface (returns new copy)."""
        return self.model_copy(update={"device": value})

    def with_mode(self, value: str) -> "WirelessInterface":
        """Set the mode (e.g., 'ap', 'sta', 'mesh') (returns new copy)."""
        return self.model_copy(update={"mode": value})

    def with_network(self, value: str) -> "WirelessInterface":
        """Set the network this interface belongs to (returns new copy)."""
        return self.model_copy(update={"network": value})

    def with_ssid(self, value: str) -> "WirelessInterface":
        """Set the SSID (returns new copy)."""
        return self.model_copy(update={"ssid": value})

    def with_encryption(self, value: str) -> "WirelessInterface":
        """Set the encryption type (e.g., 'psk2', 'sae', 'none') (returns new copy)."""
        return self.model_copy(update={"encryption": value})

    def with_key(self, value: str) -> "WirelessInterface":
        """Set the encryption key/password (returns new copy)."""
        return self.model_copy(update={"key": value})

    def with_ifname(self, value: str) -> "WirelessInterface":
        """Set the interface name (returns new copy)."""
        return self.model_copy(update={"ifname": value})

    def with_mesh_id(self, value: str) -> "WirelessInterface":
        """Set the mesh ID (for mesh mode) (returns new copy)."""
        return self.model_copy(update={"mesh_id": value})

    def with_mesh_fwding(self, value: bool) -> "WirelessInterface":
        """Enable or disable mesh forwarding (returns new copy)."""
        return self.model_copy(update={"mesh_fwding": value})

    def with_mcast_rate(self, value: int) -> "WirelessInterface":
        """Set the multicast rate (returns new copy)."""
        return self.model_copy(update={"mcast_rate": value})

    def with_ieee80211r(self, value: bool) -> "WirelessInterface":
        """Enable or disable 802.11r fast transition (returns new copy)."""
        return self.model_copy(update={"ieee80211r": value})

    def with_ft_over_ds(self, value: bool) -> "WirelessInterface":
        """Enable or disable FT over DS (returns new copy)."""
        return self.model_copy(update={"ft_over_ds": value})

    def with_ft_psk_generate_local(self, value: bool) -> "WirelessInterface":
        """Enable or disable local PSK generation for FT (returns new copy)."""
        return self.model_copy(update={"ft_psk_generate_local": value})

    # Convenience builder methods for common configurations
    def with_ap(
        self, ssid: str, encryption: str = "psk2", key: Optional[str] = None
    ) -> "WirelessInterface":
        """Configure as access point (returns new copy)."""
        updates = {"mode": "ap", "ssid": ssid, "encryption": encryption}
        if key:
            updates["key"] = key
        return self.model_copy(update=updates)

    def with_mesh(
        self, mesh_id: str, encryption: str = "sae", key: Optional[str] = None
    ) -> "WirelessInterface":
        """Configure as mesh interface (returns new copy)."""
        updates = {"mode": "mesh", "mesh_id": mesh_id, "encryption": encryption}
        if key:
            updates["key"] = key
        return self.model_copy(update=updates)

with_device(value)

Set the radio device for this interface (returns new copy).

Source code in src/wrtkit/wireless.py 
69
70
71
def with_device(self, value: str) -> "WirelessInterface":
    """Set the radio device for this interface (returns new copy)."""
    return self.model_copy(update={"device": value})

with_mode(value)

Set the mode (e.g., 'ap', 'sta', 'mesh') (returns new copy).

Source code in src/wrtkit/wireless.py 
73
74
75
def with_mode(self, value: str) -> "WirelessInterface":
    """Set the mode (e.g., 'ap', 'sta', 'mesh') (returns new copy)."""
    return self.model_copy(update={"mode": value})

with_network(value)

Set the network this interface belongs to (returns new copy).

Source code in src/wrtkit/wireless.py 
77
78
79
def with_network(self, value: str) -> "WirelessInterface":
    """Set the network this interface belongs to (returns new copy)."""
    return self.model_copy(update={"network": value})

with_ssid(value)

Set the SSID (returns new copy).

Source code in src/wrtkit/wireless.py 
81
82
83
def with_ssid(self, value: str) -> "WirelessInterface":
    """Set the SSID (returns new copy)."""
    return self.model_copy(update={"ssid": value})

with_encryption(value)

Set the encryption type (e.g., 'psk2', 'sae', 'none') (returns new copy).

Source code in src/wrtkit/wireless.py 
85
86
87
def with_encryption(self, value: str) -> "WirelessInterface":
    """Set the encryption type (e.g., 'psk2', 'sae', 'none') (returns new copy)."""
    return self.model_copy(update={"encryption": value})

with_key(value)

Set the encryption key/password (returns new copy).

Source code in src/wrtkit/wireless.py 
89
90
91
def with_key(self, value: str) -> "WirelessInterface":
    """Set the encryption key/password (returns new copy)."""
    return self.model_copy(update={"key": value})

with_ifname(value)

Set the interface name (returns new copy).

Source code in src/wrtkit/wireless.py 
93
94
95
def with_ifname(self, value: str) -> "WirelessInterface":
    """Set the interface name (returns new copy)."""
    return self.model_copy(update={"ifname": value})

with_mesh_id(value)

Set the mesh ID (for mesh mode) (returns new copy).

Source code in src/wrtkit/wireless.py 
97
98
99
def with_mesh_id(self, value: str) -> "WirelessInterface":
    """Set the mesh ID (for mesh mode) (returns new copy)."""
    return self.model_copy(update={"mesh_id": value})

with_mesh_fwding(value)

Enable or disable mesh forwarding (returns new copy).

Source code in src/wrtkit/wireless.py 
101
102
103
def with_mesh_fwding(self, value: bool) -> "WirelessInterface":
    """Enable or disable mesh forwarding (returns new copy)."""
    return self.model_copy(update={"mesh_fwding": value})

with_mcast_rate(value)

Set the multicast rate (returns new copy).

Source code in src/wrtkit/wireless.py 
105
106
107
def with_mcast_rate(self, value: int) -> "WirelessInterface":
    """Set the multicast rate (returns new copy)."""
    return self.model_copy(update={"mcast_rate": value})

with_ieee80211r(value)

Enable or disable 802.11r fast transition (returns new copy).

Source code in src/wrtkit/wireless.py 
109
110
111
def with_ieee80211r(self, value: bool) -> "WirelessInterface":
    """Enable or disable 802.11r fast transition (returns new copy)."""
    return self.model_copy(update={"ieee80211r": value})

with_ft_over_ds(value)

Enable or disable FT over DS (returns new copy).

Source code in src/wrtkit/wireless.py 
113
114
115
def with_ft_over_ds(self, value: bool) -> "WirelessInterface":
    """Enable or disable FT over DS (returns new copy)."""
    return self.model_copy(update={"ft_over_ds": value})

with_ft_psk_generate_local(value)

Enable or disable local PSK generation for FT (returns new copy).

Source code in src/wrtkit/wireless.py 
117
118
119
def with_ft_psk_generate_local(self, value: bool) -> "WirelessInterface":
    """Enable or disable local PSK generation for FT (returns new copy)."""
    return self.model_copy(update={"ft_psk_generate_local": value})

with_ap(ssid, encryption='psk2', key=None)

Configure as access point (returns new copy).

Source code in src/wrtkit/wireless.py 
122
123
124
125
126
127
128
129
def with_ap(
    self, ssid: str, encryption: str = "psk2", key: Optional[str] = None
) -> "WirelessInterface":
    """Configure as access point (returns new copy)."""
    updates = {"mode": "ap", "ssid": ssid, "encryption": encryption}
    if key:
        updates["key"] = key
    return self.model_copy(update=updates)

with_mesh(mesh_id, encryption='sae', key=None)

Configure as mesh interface (returns new copy).

Source code in src/wrtkit/wireless.py 
131
132
133
134
135
136
137
138
def with_mesh(
    self, mesh_id: str, encryption: str = "sae", key: Optional[str] = None
) -> "WirelessInterface":
    """Configure as mesh interface (returns new copy)."""
    updates = {"mode": "mesh", "mesh_id": mesh_id, "encryption": encryption}
    if key:
        updates["key"] = key
    return self.model_copy(update=updates)

Usage Example

from wrtkit import UCIConfig
from wrtkit.wireless import WirelessRadio, WirelessInterface

config = UCIConfig()

# Create a radio
radio = WirelessRadio("radio0")\
    .with_channel(11)\
    .with_htmode("HT20")\
    .with_country("US")\
    .with_disabled(False)
config.wireless.add_radio(radio)

# Create an AP interface
ap = WirelessInterface("ap")\
    .with_device("radio0")\
    .with_ap("MyNetwork", "psk2", "password123")\
    .with_network("lan")
config.wireless.add_interface(ap)

See Also