Get information on a given wireless network.
You must have previously called list_networks to capture network information from a given interface and then you can iterate over those results by calling this function. If the network name is longer than 20 bytes, you can call this function with a nonzero offset in order to retrieve the higher parts of the name. The same header information is repeated with each call, not just when offset=0.
The response contains:
To enquire about the active network for the interface, pass -1 as the index.
Get the active network for a given interface.
A network interface index.
WirelessNetwork show-as string: The active wireless network.
Begin pushing settings for a new configuration.
Set up the ethernet configuration of a device. Currently only designed for static ip allocation.
The index of the interface that we wish to configure as an ethernet network. This should be a wifi type interface.
An optional static ipv4 address in X.Y.Z.W format
An optional dns server in X.Y.Z.W format, only used if combined with static_ip.
An optional netmask in X.Y.Z.W format, only used if combined with static_ip.
An optional default gateway for routing traffic. Only used if combined with static_ip.
Setup a basic wifi connection.
You need to enter the network ssid and password (if there is one). If you want a default dhcp based connection those are the only settings you need. Otherwise, you can specify a static IP address by passing static_ip, dns, netmask and gateway.
If you want to create a wifi hotspot, you can pass shared=True and the network name and password are used to create a wifi hotspot. If you combine shared=True with a static IP then you can set the IP of the node and the netmask it will use to allocate IPs for other computers connecting to its hotspot. The dns and gateway options are ignored if shared=True.
The index of the interface that we wish to configure as a wifi network. This should be a wifi type interface.
The ssid of the network that you wish to join
An optional password for the network
An optional static ipv4 address in X.Y.Z.W format
An optional dns server in X.Y.Z.W format, only used if combined with static_ip.
An optional netmask in X.Y.Z.W format, only used if combined with static_ip.
An optional default gateway for routing traffic. Only used if combined with static_ip.
Whether to setup the interface as a hotspot or not.
Finish pushing settings for a new configuration.
Get basic information about a network interface.
This information includes the type of interface, whether it is currently connected to a media / ethernet cable and what its IP information is.
The index of the interface we wish to query. This must be < the count returned by list_interfaces.
InterfaceInfo show-as string: An InterfaceInfo structure with the interface info.
Capture and count the network interfaces on this device.
This function must be called before any other interface related functions are called since it captures the network devices for future access.
The interfaces may be accessed by index after calling this function and their index number will always point to the same device until this function is called again.
: The count of network devices.
List all visible networks for a given interface.
A network interface index.
A list of visible WirelessNetwork objects
Get information on a given wireless network.
You must have previously called list_networks to capture network information from a given interface and then you can iterate over those results by calling this function. If the network name is longer than 20 bytes, you can call this function with a nonzero offset in order to retrieve the higher parts of the name. The same header information is repeated with each call, not just when offset=0.
The response contains:
To enquire about the active network for the interface, pass -1 as the index.
The index of the network to enquire about. Pass -1 to ask about the active network
Push a config setting by short id code.
Generated using TypeDoc
Class to configure the network for a raspberry pi based access point