Service add-ons

2017-11-27T20:27:05Z

V-Turn:

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">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon id="service.example"
name="Example service"
version="1.0.0"
provider-name="">
<requires>
<import addon="xbmc.python" version="2.1.0"/>
</requires>
<extension point="xbmc.service" library="service.py" start="login" />
<extension point="xbmc.addon.metadata">
<platform>all</platform>
<summary lang="en"></summary>
</extension>
</addon>
</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>.

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

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

if __name__ == '__main__':
monitor = xbmc.Monitor()

while not monitor.abortRequested():
# Sleep/wait for abort for 10 seconds
if monitor.waitForAbort(10):
# Abort was requested while waiting. We should exit
break
xbmc.log("hello addon! %s" % time.time(), level=xbmc.LOGNOTICE)
</syntaxhighlight>

== 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.

Example:

<syntaxhighlight lang="python">
import xbmc

if __name__ == '__main__':
while not xbmc.abortRequested:
# some code
xbmc.sleep(500)
</syntaxhighlight>

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

Official Kodi Wiki - User contributions [en]

Service add-ons