tristonarmstrong/ExtronLib-CDS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make all callable types None

Browse Source 
This is because for some reason pylint isnt parsing the docstring
This commit is contained in:
Triston Armstrong 2021-09-21 10:55:43 -05:00
parent f7371ce7c4
commit aec427cc08
2 changed files with 54 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
extronlib/device/ProcessorDevice.py
View File

@ -67,7 +67,7 @@ class ProcessorDevice():
"""
DeviceAlias: str
ExecutiveMode: int
ExecutiveModeChanged: callable
ExecutiveModeChanged = None
"""Event: Triggers when executive mode changes.
The callback takes two arguments. The first is the extronlib.device instance triggering the event and the second is the executive mode number.
@ -94,14 +94,14 @@ class ProcessorDevice():
- For control processors with AV LAN, the LAN address is returned.
"""
ModelName: str
Offline: callable
Offline = None
"""
Event:
- Triggers when the device goes offline.
The callback takes two arguments. The first one is the extronlib.device instance triggering the event and the second one is a string ('Offline').
"""
Online: callable
Online = None
"""
Event:
- Triggers when the device goes online.
@ -122,44 +122,44 @@ class ProcessorDevice():
Example:
```
{
- 'Network': {
- 'LAN': [
- - 'DNSServers': ['192.168.1.1',],
- - 'Gateway': '192.168.254.1',
- - 'Hostname': 'ConfRoom',
- - 'IPAddress': '192.168.254.250',
- - 'SubnetMask': '255.255.255.0',
- - 'SearchDomains': ['extron.com',],
- ],
- 'AVLAN': [
- - 'DHCPServer': 'Off',
- - 'DNSServers': ['192.168.1.1',],
- - 'Hostname': 'ConfRoom',
- - 'IPAddress': '192.168.253.251',
- - 'SubnetMask': '255.255.255.0',
- - 'SearchDomains': ['extron.com',],
- ],
- },
- 'MailServer': {
- 'IPAddress': '192.168.254.100',
- 'SMTPPort': 25,
- 'SSLEnabled': True,
- 'UserID': 'jdoe',
- },
- 'DateTime': {
- 'NTPSettings': {
- - 'Enabled': True,
- - 'Server': '192.168.254.101', # '' if Enable == False
- },
- 'TimeZone': '(UTC-08:00/UTC-07:00) Pacific Time',
- }
- 'ProgramInformation': {
- 'Author': 'jdoe',
- 'DeviceName': 'IPCP Pro 550 : 192.168.254.250',
- 'FileLoaded': 'GS Project.gs',
- 'LastUpdated': '1/23/2016 9:08:29 AM',
- 'SoftwareVersion': '1.0.2.195',
- }
'Network': {
'LAN': [
'DNSServers': ['192.168.1.1',],
'Gateway': '192.168.254.1',
'Hostname': 'ConfRoom',
'IPAddress': '192.168.254.250',
'SubnetMask': '255.255.255.0',
'SearchDomains': ['extron.com',],
],
'AVLAN': [
'DHCPServer': 'Off',
'DNSServers': ['192.168.1.1',],
'Hostname': 'ConfRoom',
'IPAddress': '192.168.253.251',
'SubnetMask': '255.255.255.0',
'SearchDomains': ['extron.com',],
],
},
'MailServer': {
'IPAddress': '192.168.254.100',
'SMTPPort': 25,
'SSLEnabled': True,
'UserID': 'jdoe',
},
'DateTime': {
'NTPSettings': {
'Enabled': True,
'Server': '192.168.254.101', # '' if Enable == False
},
'TimeZone': '(UTC-08:00/UTC-07:00) Pacific Time',
}
'ProgramInformation': {
'Author': 'jdoe',
'DeviceName': 'IPCP Pro 550 : 192.168.254.250',
'FileLoaded': 'GS Project.gs',
'LastUpdated': '1/23/2016 9:08:29 AM',
'SoftwareVersion': '1.0.2.195',
}
}
```
"""
@ -169,7 +169,6 @@ class ProcessorDevice():
ProcessorDevice class constructor.
Arguments:
- DeviceAlias (string) - Device Alias of the Extron device
- PartNumber (string) - device’s part number
"""

26
extronlib/device/UIDevice.py
View File

@ -79,7 +79,7 @@ class UIDevice():
AmbientLightValue: int
AutoBrightness: bool
Brightness: int
BrightnessChanged: callable
BrightnessChanged = None
"""
## Event:
- Triggers when LCD brightness has changed.
@ -105,7 +105,7 @@ class UIDevice():
"""Return display timer timeout seconds"""
DisplayTimerEnabled: bool
FirmwareVersion: str
HDCPStatusChanged: callable
HDCPStatusChanged = None
"""
## Event:
- Triggers when HDCP Status changes.
@ -124,7 +124,7 @@ class UIDevice():
"""
Hostname: str
IPAddress: str
InactivityChanged: callable
InactivityChanged = None
"""
## Event:
- Triggers at times specified by SetInactivityTime() after state transition of inactivity timer.
@ -152,7 +152,7 @@ class UIDevice():
Note:
- 0 = Active, Nonzero = Time of inactivity.
"""
InputPresenceChanged: callable
InputPresenceChanged = None
"""
## Event:
- Triggers when Input Presence changes.
@ -172,7 +172,7 @@ class UIDevice():
PodiumTLP.ShowPopup('No Input Available')
```
"""
LidChanged: callable
LidChanged = None
"""
## Event:
- Triggers when the Lid state changes.
@ -181,7 +181,7 @@ class UIDevice():
"""
LidState: str
"""the current lid state ('Opened' or 'Closed')"""
LightChanged: callable
LightChanged = None
"""
## Event:
- Triggers when ambient light changes
@ -194,7 +194,7 @@ class UIDevice():
ModelName: str
MotionDecayTime: int
""" the period of time to trigger MotionDetected event after last motion was detected. The default (and minimum) value is 10 seconds."""
MotionDetected: callable
MotionDetected = None
"""
## Event:
- Triggers when Motion is detected.
@ -203,14 +203,14 @@ class UIDevice():
"""
MotionState: str
"""the state of the Motion sensor (e.g. Motion, No Motion)"""
Offline: callable
Offline = None
"""
## Event:
- Triggers when the device goes offline.
The callback takes two arguments. The first one is the extronlib.device instance triggering the event and the second one is a string ('Offline').
"""
Online: callable
Online = None
"""
## Event:
- Triggers when the device comes online.
@ -219,7 +219,7 @@ class UIDevice():
"""
PartNumber: str
SerialNumber: str
SleepChanged: callable
SleepChanged = None
"""
## Event:
- Triggers when sleep state changes.
@ -269,7 +269,7 @@ class UIDevice():
print(PoduiumTLP.OverTemperature)
```
"""
OverTemperatureChanged: callable
OverTemperatureChanged = None
"""
## Event:
- Triggers when Over Temperature changes.
@ -290,7 +290,7 @@ class UIDevice():
print('Podium TLP OverTemperature is ' + str(temp))
```
"""
OverTemperatureWarning: callable
OverTemperatureWarning = None
"""
## Event:
- Triggers when the product’s operating temperature exceeds the maximum by 5 percent.
@ -331,7 +331,7 @@ class UIDevice():
print('Podium TLP is over maximum temperature.')
```
"""
OverTemperatureWarningStateChanged: callable
OverTemperatureWarningStateChanged = None
"""
## Event:
- Triggers when the product’s operating temperature warning changes state.