Urfkill.Killswitch¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
Virtual Methods¶
- Inherited:
|
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w |
The state of the killswitch |
Signals¶
- Inherited:
Name |
Short Description |
---|---|
The state-changed signal is emitted when the killswitch state is changed. |
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent |
r |
Class Details¶
- class Urfkill.Killswitch(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
The
Urfkill.Killswitch
struct contains only private fields and should not be directly accessed.- classmethod new(type)¶
- Parameters:
type (
Urfkill.EnumType
) – The killswitch type- Returns:
a new
Urfkill.Killswitch
object.- Return type:
Creates a new
Urfkill.Killswitch
object.New in version 0.3.0.
- get_switch_type()¶
- Returns:
The type of the killswitch
- Return type:
Get the type of the killswitch.
New in version 0.3.0.
- do_state_changed(state) virtual¶
- Parameters:
state (
Urfkill.EnumState
) –
Signal Details¶
- Urfkill.Killswitch.signals.state_changed(killswitch, state)¶
- Signal Name:
state-changed
- Flags:
- Parameters:
killswitch (
Urfkill.Killswitch
) – The object which received the signalstate (
int
) – the new state
The state-changed signal is emitted when the killswitch state is changed. See
Urfkill.EnumState
.New in version 0.3.0.
Property Details¶
- Urfkill.Killswitch.props.state¶
-
The state of the killswitch. See
Urfkill.EnumState
.Writing the states other than
Urfkill.EnumState.UNBLOCKED
orUrfkill.EnumState.SOFT_BLOCKED
will be ignored. Also, the state writing may not take effect since it depends on the state of the hardware.New in version 0.3.0.