luistripa / indigopluginbase

Type hinting helper module for Indigo Domotics plugin development

Hi there 👋, I'm Luis Tripa

A computer engineering student passionate about outer space :)

• ⚡ Fun fact I play the drums! 🥁

Connect with me:

Languages and Tools:

 

indigopluginbase's Issues

Add indigo.schedules and indigo.actionGroups

IndigoPluginBase/indigo/__init__.py

Line 20 in 95e9ac6

# TODO: Missing schedules and actionGroups

indigo.sever module still missing a few methods

Where to find the documentation for the indigo.server module:

https://wiki.indigodomo.com/doku.php?id=indigo_2022.1_documentation:server_commands#get_plugin

Methods getPluginList and getPlugin missing docstrings

IndigoPluginBase/indigo/server.py

Lines 22 to 27 in 8143396

	def getPluginList() -> list[indigo.PluginInfo]:
	return []
	def getPlugin(pluginId: str) -> indigo.PluginInfo:
	pass

"Folders" to DeviceList, VariableList, etc.

The indigo..folder. methods must be added to the DeviceList, VariableList, etc.

Docs can be found at this link:
https://wiki.indigodomo.com/doku.php?id=indigo_7_documentation:folder_class

PluginInfo class missing docstring in methods

IndigoPluginBase/indigo/_plugin/__init__.py

Lines 9 to 30 in 1e6e69c

	class PluginInfo:
	pluginId: str = "IndigoPluginBase"
	pluginVersion: str = "1.0.0"
	pluginSupportURL: str = ""
	def isInstalled(self) -> bool:
	return True
	def isEnabled(self) -> bool:
	return True
	def isRunning(self) -> bool:
	return True
	def restart(self, waitUnitlDone=True):
	pass
	def executeAction(self, actionId: str, deviceId: int, props: dict):
	pass
	# TODO: Add more methods

cmdBytes return value in `indigo.zwave.sendRaw`

Need to verify if the cmdBytes is really a bytes object or a list of something else

PluginInfo class missing a few methods

IndigoPluginBase/indigo/_plugin/__init__.py

Lines 9 to 30 in 1e6e69c

	class PluginInfo:
	pluginId: str = "IndigoPluginBase"
	pluginVersion: str = "1.0.0"
	pluginSupportURL: str = ""
	def isInstalled(self) -> bool:
	return True
	def isEnabled(self) -> bool:
	return True
	def isRunning(self) -> bool:
	return True
	def restart(self, waitUnitlDone=True):
	pass
	def executeAction(self, actionId: str, deviceId: int, props: dict):
	pass
	# TODO: Add more methods

The following methods/properties need to be implemented:

• compatibleUpdateAvailable
• includedWithServer
• incompatibleUpdateAvailable
• latestCompatibleDownloadCount
• latestCompatibleDownloadURL
• latestCompatibleReleaseDate
• latestCompatibleSummaryDesc
• latestCompatibleVers
• latestCompatibleWhatsNewDesc
• latestReleaseDate
• latestRequiresIndigoVers
• latestVers
• pluginDisplayName
• pluginFolderPath
• pluginServerApiVersion
• restartAndDebug
• storeIconURL
• storeName
• storePluginURL
• storeSummary

indigo.trigger methods missing docstring in all methods

Missing documentation for the useEncryption param of the `indigo.zwave.enterInclusionMode` function