Service add-ons - Revision history

RogueScholar: Fix dead-end page and edit for concision

2021-09-23T01:41:04Z

Fix dead-end page and edit for concision

← Older revision		Revision as of 01:41, 23 September 2021
Line 1:		Line 1:
			Service [[add-ons]] will be automatically started when a [[Profiles\|user profile]] logs in or on Kodi startup, and stopped when the user profile logs out. They must offer the '''<code>xbmc.service</code>''' extension point. Here's a typical example of the contents of the [[addon.xml]] file such add-ons need to provide:

	Service addons will be automatically started when a user profile logs in or on Kodi startup, and stopped when the user profile logs out. These addons must offer the '''xbmc.service''' extension point. Here's a typical example of the addon.xml the addon needs to provide:		<syntaxhighlight lang="xml">

	<syntaxhighlight lang=xml>
	<?xml version="1.0" encoding="UTF-8" standalone="yes"?>		<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	<addon id="service.example"		<addon id="service.example"
Line 19:		Line 18:
	</syntaxhighlight>		</syntaxhighlight>

	If your ~~addon~~ is meant to be run while Kodi is running, you need to periodically check if Kodi is exiting. The ~~addon~~ is responsible for terminating when Kodi wants to exit. This can be checked by creating a <code>xbmc.Monitor</code> instance and calling the <code>abortRequested()</code> method. To wait for this event instead, call <code>waitForAbort()</code>.		If your add-on is meant to be run while Kodi is running, you need to periodically check if Kodi is exiting. The add-on is responsible for terminating when Kodi wants to exit. This can be checked by creating an <code>xbmc.Monitor</code> instance and calling the <code>abortRequested()</code> method. To wait for this event instead, call the <code>waitForAbort()</code> method.

	~~Example~~ service that prints "hello addon!" every 10 ~~second~~ until Kodi exits:		Below is an example service that prints "hello addon!" every 10 seconds until Kodi exits:

	<syntaxhighlight lang=python>		<syntaxhighlight lang="python">
	import time		import time
	import xbmc		import xbmc
Line 37:		Line 36:
	xbmc.log("hello addon! %s" % time.time(), level=xbmc.LOGDEBUG)		xbmc.log("hello addon! %s" % time.time(), level=xbmc.LOGDEBUG)
	</syntaxhighlight>		</syntaxhighlight>


	== Gotham and earlier ==		== Gotham and earlier ==
	<code>abortRequested()</code> and <code>waitForAbort()</code> are new in Helix. In Gotham and earlier, use <code>xbmc.sleep</code> and check the <code>xbmc.abortRequested</code> attribute periodically.		<code>abortRequested()</code> and <code>waitForAbort()</code> are new methods introduced with Kodi [[Archive:Helix\|Helix]]. In [[Archive:Gotham API changes\|Gotham]] and earlier, use <code>xbmc.sleep</code> and check the <code>xbmc.abortRequested</code> attribute periodically.

	Example:		Example:

	<syntaxhighlight lang=python>		<syntaxhighlight lang="python">
	import xbmc		import xbmc

Line 53:		Line 51:
	</syntaxhighlight>		</syntaxhighlight>

			== Leia and earlier ==
	Prior to Kodi 18 Leia there was an additional option ''start="startup"'' that would start the service add-on before the first profile login, but that functionality and ~~usefulness were limited so this option~~ was removed.		Prior to Kodi v18 [[Leia]], there was an additional option, <code>start="startup"</code>, that would start the service add-on before the first profile login, but the usefulness of that functionality was found to be negligible, and it was removed.


	[[Category:Add-on development]]		[[Category:Add-on development]]

Ronie at 16:04, 15 August 2021

2021-08-15T16:04:57Z

← Older revision		Revision as of 16:04, 15 August 2021
Line 35:		Line 35:
	# Abort was requested while waiting. We should exit		# Abort was requested while waiting. We should exit
	break		break
	xbmc.log("hello addon! %s" % time.time(), level=xbmc.~~LOGNOTICE~~)		xbmc.log("hello addon! %s" % time.time(), level=xbmc.LOGDEBUG)
	</syntaxhighlight>		</syntaxhighlight>

Karellen at 01:13, 21 August 2020

2020-08-21T01:13:38Z

← Older revision		Revision as of 01:13, 21 August 2020
Line 56:		Line 56:
	Prior to Kodi 18 Leia there was an additional option ''start="startup"'' that would start the service add-on before the first profile login, but that functionality and usefulness were limited so this option was removed.		Prior to Kodi 18 Leia there was an additional option ''start="startup"'' that would start the service add-on before the first profile login, but that functionality and usefulness were limited so this option was removed.

	~~[[Category:How-to]]~~
	[[Category:Add-on development]]		[[Category:Add-on development]]

Davu at 12:35, 10 July 2018

2018-07-10T12:35:43Z

← Older revision		Revision as of 12:35, 10 July 2018
Line 2:		Line 2:
	Service addons will be automatically started when a user profile logs in or on Kodi startup, and stopped when the user profile logs out. These addons must offer the '''xbmc.service''' extension point. Here's a typical example of the addon.xml the addon needs to provide:		Service addons will be automatically started when a user profile logs in or on Kodi startup, and stopped when the user profile logs out. These addons must offer the '''xbmc.service''' extension point. Here's a typical example of the addon.xml the addon needs to provide:

	<syntaxhighlight lang="xml">		<syntaxhighlight lang=xml>
	<?xml version="1.0" encoding="UTF-8" standalone="yes"?>		<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
	<addon id="service.example"		<addon id="service.example"
Line 23:		Line 23:
	Example service that prints "hello addon!" every 10 second until Kodi exits:		Example service that prints "hello addon!" every 10 second until Kodi exits:

	<syntaxhighlight lang="python">		<syntaxhighlight lang=python>
	import time		import time
	import xbmc		import xbmc
Line 44:		Line 44:
	Example:		Example:

	<syntaxhighlight lang="python">		<syntaxhighlight lang=python>
	import xbmc		import xbmc

Rmrector at 16:47, 3 May 2018

2018-05-03T16:47:07Z

← Older revision		Revision as of 16:47, 3 May 2018
Line 1:		Line 1:

	Service addons will be automatically started when Kodi ~~starts~~. These addons must offer the '''xbmc.service''' extension point. You can specify when you want your addon to start, using the '''start''' tag. If it's isn't here, your addon will automatically start after user login. If you want it to start on Kodi startup, you need to set the '''start''' tag to ''startup''. Here's a typical example of the addon.xml the addon needs to provide:		Service addons will be automatically started when a user profile logs in or on Kodi startup, and stopped when the user profile logs out. These addons must offer the '''xbmc.service''' extension point. Here's a typical example of the addon.xml the addon needs to provide:

	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
Line 11:		Line 11:
	<import addon="xbmc.python" version="2.1.0"/>		<import addon="xbmc.python" version="2.1.0"/>
	</requires>		</requires>
	<extension point="xbmc.service" library="service.py~~" start="login~~" />		<extension point="xbmc.service" library="service.py" />
	<extension point="xbmc.addon.metadata">		<extension point="xbmc.addon.metadata">
	<platform>all</platform>		<platform>all</platform>
Line 52:		Line 52:
	xbmc.sleep(500)		xbmc.sleep(500)
	</syntaxhighlight>		</syntaxhighlight>


			Prior to Kodi 18 Leia there was an additional option ''start="startup"'' that would start the service add-on before the first profile login, but that functionality and usefulness were limited so this option was removed.

	[[Category:How-to]]		[[Category:How-to]]
	[[Category:Add-on development]]		[[Category:Add-on development]]

V-Turn at 20:27, 27 November 2017

2017-11-27T20:27:05Z

← Older revision		Revision as of 20:27, 27 November 2017
Line 35:		Line 35:
	# Abort was requested while waiting. We should exit		# Abort was requested while waiting. We should exit
	break		break
	xbmc.log("hello addon! %s" % time.time(), level=xbmc.~~LOGDEBUG~~)		xbmc.log("hello addon! %s" % time.time(), level=xbmc.LOGNOTICE)
	</syntaxhighlight>		</syntaxhighlight>

Enen92: unecessary code for gotham and earlier if using xbmc.abortRequested in the while statement

2015-08-27T13:24:13Z

unecessary code for gotham and earlier if using xbmc.abortRequested in the while statement

← Older revision		Revision as of 13:24, 27 August 2015
Line 49:		Line 49:
	if __name__ == '__main__':		if __name__ == '__main__':
	while not xbmc.abortRequested:		while not xbmc.abortRequested:
	~~if xbmc.abortRequested:~~
	~~break~~
	# some code		# some code
	xbmc.sleep(500)		xbmc.sleep(500)

Enen92: Avoid using while true statements in kodi scripts or encourage people to use them. It might cause kodi to hang on shutdown if not used properly.

2015-08-27T13:22:58Z

Avoid using while true statements in kodi scripts or encourage people to use them. It might cause kodi to hang on shutdown if not used properly.

← Older revision		Revision as of 13:22, 27 August 2015
Line 30:		Line 30:
	monitor = xbmc.Monitor()		monitor = xbmc.Monitor()

	while ~~True~~:		while not monitor.abortRequested():
	# Sleep/wait for abort for 10 seconds		# Sleep/wait for abort for 10 seconds
	if monitor.waitForAbort(10):		if monitor.waitForAbort(10):
Line 48:		Line 48:

	if __name__ == '__main__':		if __name__ == '__main__':
	while ~~True~~:		while not xbmc.abortRequested:
	if xbmc.abortRequested:		if xbmc.abortRequested:
	break		break

Enen92: xbmc to kodi

2015-08-27T13:08:52Z

xbmc to kodi

← Older revision		Revision as of 13:08, 27 August 2015
Line 1:		Line 1:

	Service addons will be automatically started when ~~XBMC~~ starts. These addons must offer the '''xbmc.service''' extension point. You can specify when you want your addon to start, using the '''start''' tag. If it's isn't here, your addon will automatically start after user login. If you want it to start on Kodi startup, you need to set the '''start''' tag to ''startup''. Here's a typical example of the addon.xml the addon needs to provide:		Service addons will be automatically started when Kodi starts. These addons must offer the '''xbmc.service''' extension point. You can specify when you want your addon to start, using the '''start''' tag. If it's isn't here, your addon will automatically start after user login. If you want it to start on Kodi startup, you need to set the '''start''' tag to ''startup''. Here's a typical example of the addon.xml the addon needs to provide:

	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">

Enen92: Simple XBMC to Kodi rename

2015-08-27T13:08:22Z

Simple XBMC to Kodi rename

← Older revision		Revision as of 13:08, 27 August 2015
Line 1:		Line 1:

	Service addons will be automatically started when XBMC starts. These addons must offer the '''xbmc.service''' extension point. You can specify when you want your addon to start, using the '''start''' tag. If it's isn't here, your addon will automatically start after user login. If you want it to start on ~~XBMC~~ startup, you need to set the '''start''' tag to ''startup''. Here's a typical example of the addon.xml the addon needs to provide:		Service addons will be automatically started when XBMC starts. These addons must offer the '''xbmc.service''' extension point. You can specify when you want your addon to start, using the '''start''' tag. If it's isn't here, your addon will automatically start after user login. If you want it to start on Kodi startup, you need to set the '''start''' tag to ''startup''. Here's a typical example of the addon.xml the addon needs to provide:

	<syntaxhighlight lang="xml">		<syntaxhighlight lang="xml">
Line 19:		Line 19:
	</syntaxhighlight>		</syntaxhighlight>

	If your addon is meant to be run while ~~XBMC~~ is running, you need to periodically check if ~~XBMC~~ is exiting. The addon is responsible for terminating when ~~XBMC~~ wants to exit. This can be checked by creating a <code>xbmc.Monitor</code> instance and calling the <code>abortRequested()</code> method. To wait for this event instead, call <code>waitForAbort()</code>.		If your addon is meant to be run while Kodi is running, you need to periodically check if Kodi is exiting. The addon is responsible for terminating when Kodi wants to exit. This can be checked by creating a <code>xbmc.Monitor</code> instance and calling the <code>abortRequested()</code> method. To wait for this event instead, call <code>waitForAbort()</code>.

	Example service that prints "hello addon!" every 10 second until ~~XBMC~~ exits:		Example service that prints "hello addon!" every 10 second until Kodi exits:

	<syntaxhighlight lang="python">		<syntaxhighlight lang="python">