doc: update hwsim documentation

This was quite dated and needed to be updated both to
reflect the API change to a dictionary argument, as well
as document NoVirtualInterface.
This commit is contained in:
James Prestwood 2022-04-05 11:50:57 -07:00 committed by Denis Kenzior
parent 96e8c0a3ab
commit 87345b4c14
1 changed files with 24 additions and 8 deletions

View File

@ -5,17 +5,33 @@ Service net.connman.hwsim
Interface net.connman.hwsim.RadioManager [Experimental] Interface net.connman.hwsim.RadioManager [Experimental]
Object path / Object path /
Methods object CreateRadio(string name, boolean p2p_device) Methods object CreateRadio(dict)
Add one virtual radio device to the simulator, a Add one virtual radio device to the simulator, a
path to a new object with the path to a new object with the
net.connman.hwsim.Radio interface is returned. net.connman.hwsim.Radio interface is returned.
The radio is created with one network interface of
the type "managed" (Station) and optionally one This API takes a dictionary of arguments (all optional)
P2P Device interface. The name parameter may be with keys:
an empty string or a requested name for the radio
and its wiphy. If empty, the kernel will use a string Name - Name of radio
default name. If non-empty, the kernel may still bool P2P - Create a P2P device
use the default name if the requested name can not string InterfaceTypeDisable - List of disabled
interface types (comma
separated)
string CipherTypeDisable - List of disabled
cipher types (comma
separated)
string NoVirtualInterface - Don't create an
interface for this
radio.
The radio is created with one network interface (unless
NoVirtualInterface is used) of the type "managed"
(Station) and optionally one P2P Device interface.
The name parameter may be an empty string or a requested
name for the radio and its wiphy. If empty, the kernel
will use a default name. If non-empty, the kernel may
still use the default name if the requested name can not
be used. be used.
Service net.connman.hwsim Service net.connman.hwsim