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

26
extronlib/device/UIDevice.py
View File

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