https://kodi.wiki/api.php?action=feedcontributions&feedformat=atom&user=Schapplm 2026-06-17T13:54:12Z User contributions MediaWiki 1.43.8 https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=223849 2021-02-14T07:41:11Z

<p>Schapplm: /* Alternatives */</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.2.7<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched state of movies and TV-series episodes independent from filenames<br /> |Description=<br /> Export: Searches the Kodi-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in Kodi.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991<br /> |Forum=https://forum.kodi.tv/showthread.php?tid=164652<br /> |Website=https://kodi.wiki/view/Add-on:WatchedList<br /> |Source=https://github.com/SchapplM/xbmc-addon-service-watchedlist<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/leia/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with Kodi after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the WatchedList database every time the user changes a watched state (from unwatched to watched and vice versa). Marking something as &quot;unwatched&quot; is only possible with this setting.<br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible during the update (can take a few minutes, depending on verbosity and amount of changes and size of database), but it is possible to abort the whole process.<br /> # Amount of User Information (&quot;verbosity&quot;): Determines, for which events a notification will be shown. This is independent from [[Log file|debug logging]]. Options: ''all'' (notification for updates of every single movie and episode), ''only info'' (default, only notification for major steps of the update process, ''only warning'', ''only error'', ''none'' (show no notifications at all)<br /> <br /> [[File:service_watchedlist_doc_settings_basic.jpg|500px|Basic Settings]]<br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in Kodi or edit this value manually in the &quot;%appdata%\Kodi\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. Set the number of backup files with this option. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. You can set this to infinite number of backups (option ''-1'') to make sure, but this will fill your disk over the years.<br /> # Dropbox synchronization: Saves your WatchedList database in your dropbox (should take max. 1MB space). If you enable this option, the [[Add-on:Dropbox|Dropbox authorization process]] will be started. If this option is activated with the same Dropbox account on several clients, it is possible to share the WatchedList database via the Dropbox.<br /> # Dropbox Auth Code: This will has to be inserted after the Dropbox authorization process (see above).<br /> # MySQL: IP-address of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user.<br /> <br /> <br /> [[File:service_watchedlist_doc_settings_database.jpg|500px|Basic Settings]]<br /> <br /> === Usage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> * After Startup, the databases are searched for watched-information (Notification 1).<br /> * Then newly watched movies and tv episodes are written to the addon database (Notification 2). <br /> * After that, media that is not watched in the Kodi database and was previously marked as watched by the addon is again marked as watched in Kodi ( Notifications 3 and 4).<br /> <br /> &lt;gallery&gt;<br /> File:service_watchedlist_doc_notification_start.png|Notification 1<br /> File:service_watchedlist_doc_notification_remember.png|Notification 2<br /> File:service_watchedlist_doc_notification_setwatched_episode.png|Notification 3<br /> File:service_watchedlist_doc_notification_setwatched_movie.png|CNotification 4<br /> &lt;/gallery&gt;<br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> <br /> [[File:service_watchedlist_doc_mysql_watched_movies.jpg|500px|phpmyAdmin View of WatchedList database]]<br /> <br /> For the description of the tables read below.<br /> <br /> ==== SQLite Database file ====<br /> <br /> This Kodi Addon creates a SQLite database file called watchedlist.db by default. I recommend using the mySQL database instead, but both methods work well (see addon settings above).<br /> <br /> To view the database you can use the Windows Tool [https://sourceforge.net/projects/sqlitebrowser/files/latest/download SQLite Database Browser] or the Linux Tool [https://sourceforge.net/projects/sqliteman/ sqliteman]. The file is by default located in %APPDATA%\Kodi\userdata\addon_data\service.watchedlist\watchedlist.db in Windows or ~/.kodi/userdata/addon_data/service.watchedlist/watchedlist.db in Linux.<br /> <br /> This first figure shows the SQLite db file with automatically created backup copies.<br /> <br /> [[File:service_watchedlist_doc_db_folder.png|500px|File overview]]<br /> <br /> The database (here opened with SQLite DB Browser) has three tables. <br /> <br /> [[File:service_watchedlist_doc_sqlite_structure.png|500px|Database overview]]<br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_movies.png|500px|Movie table overview]]<br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in Kodi, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability.<br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_episode.png|500px|Episode table overview]]<br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, the possibility to use a mysql database was added. This has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database from SQLite db file to mysql:<br /> <br /> * open the old database file in SQLite database browser<br /> * File -&gt; Export -&gt; Database to sql file<br /> * bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO `movie_watched` VALUES \((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO `movie_watched` VALUES \((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO `episode_watched` VALUES \((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO `episode_watched` VALUES \((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> ::* The exact character sequence regarding white-spaces or backticks can be different between versions of the SQLite tool and might need adaptation<br /> * Save this new sql file<br /> * execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled.<br /> <br /> == Technical Details ==<br /> <br /> The Kodi Database is queried and updated with JSON-RPC. It should not matter whether you use Kodi mysql or Kodi local database.<br /> <br /> == Limitations ==<br /> <br /> The watched-status is only stored based on imdb/thetvdb number. Different Versions of a movie (DVD, BlueRay, Extended Edition, Directors Cut) are all considered equally watched.<br /> <br /> == Alternatives ==<br /> <br /> * Online List of watched movies<br /> ::* [[Add-on:Trakt|Trakt Addon]]<br /> ::* [https://github.com/watchedsyncforkodi/service.watchedsync watchedsync (in development)]<br /> ::* [https://forum.kodi.tv/showthread.php?tid=128542 Follw-It Addon] (Last update April 2012, probably not working any more) <br /> * Addon that exports the watched-state to the nfo files of the movies<br /> ::* [https://www.kodinerds.net/index.php/Thread/36207-Release-NFO-Watchedstate-Updater/|NFO Watchedstate Updater]<br /> * separate script to scan Kodi library (probably not executable from within Kodi and not working any more)<br /> ::* http://forum.kodi.tv/showthread.php?tid=62874&amp;pid=1280902#pid1280902 <br /> * other similar addons<br /> ::* http://forum.kodi.tv/showthread.php?tid=129448&amp;pid=1401643#pid1401643 (not working any more) <br /> * Export watched flag in nfo file and Import it back again:<br /> ::* [[Advancedsettings.xml]] Section: Video Library<br /> <br /> == Feedback and Discussion ==<br /> <br /> In case of errors or questions, please post them [http://forum.kodi.tv/showthread.php?tid=164652 in the forum thread].<br /> <br /> [[Category:Add-ons with license tag]]<br /> [[Category:Add-ons with source tag]]<br /> [[Category:Add-ons with website tag]]<br /> [[Category:All add-ons]]<br /> [[Category:Program add-ons]]<br /> [[Category:Krypton add-on repository]]<br /> [[Category:Isengard add-on repository]]<br /> [[Category:Matrix add-on repository]]<br /> [[Category:Helix add-on repository]]<br /> [[Category:Leia add-on repository]]<br /> [[Category:Jarvis add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:Dropbox&diff=204972 2020-04-25T10:36:29Z

<p>Schapplm: /* Method A */</p> <hr /> <div>{{Addon <br /> |Name=dropbox<br /> |provider-name=micah<br /> |ID=script.module.dropbox<br /> |latest-version=2.2.0<br /> |extension point=xbmc.python.module<br /> |provides=<br /> |Summary=Provide Dropbox Python API support<br /> |Description=Provide Dropbox Python API support<br /> |Platform=all<br /> |Language=<br /> |License=Apache2<br /> |Forum=<br /> |Website=<br /> |Source=http://python-requests.org<br /> |Email=micahgalizia AT gmail.com<br /> |broken=<br /> |icon url=}}<br /> = Installation =<br /> <br /> This addon does not have to be installed: It is a prerequisite for other addons and will be installed automatically when installing these other addons.<br /> <br /> = About the Addon = <br /> <br /> This addon provides access to the dropbox API to other addons. Addons registered as Dropbox Apps have a separate folder in the dropbox file structure and can access files only in this folder.<br /> This addon does not provide access to the files in the general dropbox file system.<br /> The addon is triggered by opening a settings field in an addon using the Dropbox API.<br /> <br /> = Useage = <br /> <br /> * By opening the settings field &quot;dropbox authorization code&quot; from another addon, a link is displayed<br /> <br /> == Method A ==<br /> <br /> * open the link by using a QR code reader app on your smartphone ( in a browser on your smartphone)<br /> * enter your dropbox credentials and confirm<br /> * copy the authorization code<br /> * click next on your Kodi device<br /> * use a remote control smartphone app (like YATSE) to paste the authorization code into the dialog<br /> * click next in the Kodi dialog<br /> <br /> Disclaimer: This only works until Kodi Leia (v. 18), not Matrix (v. 19).<br /> <br /> == Method B ==<br /> <br /> * open the link manually in a browser<br /> * type the authorization code with your keyboard in the Kodi dialog (Kodi does not support copy-paste, since it is designed for no-input-devices)<br /> <br /> [[Category:Add-on libraries/modules]]<br /> [[Category:Add-ons with license tag]]<br /> [[Category:Add-ons with source tag]]<br /> [[Category:All add-ons]]<br /> [[Category:Krypton add-on repository]]<br /> [[Category:Isengard add-on repository]]<br /> [[Category:Matrix add-on repository]]<br /> [[Category:Leia add-on repository]]<br /> [[Category:Jarvis add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=132116 2017-12-30T10:11:24Z

<p>Schapplm: /* Alternatives */</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.2.2<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched state of movies and TV-series episodes independent from filenames<br /> |Description=<br /> Export: Searches the Kodi-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in Kodi.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991<br /> |Forum=http://forum.kodi.tv/showthread.php?tid=164652<br /> |Website=http://kodi.wiki/view/Add-on:WatchedList<br /> |Source=https://github.com/SchapplM/xbmc-addon-service-watchedlist<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/krypton/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with Kodi after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the WatchedList database every time the user changes a watched state (from unwatched to watched and vice versa). Marking something as &quot;unwatched&quot; is only possible with this setting.<br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible during the update (can take a few minutes, depending on verbosity and amount of changes and size of database), but it is possible to abort the whole process.<br /> # Amount of User Information (&quot;verbosity&quot;): Determines, for which events a notification will be shown. This is independent from [[Debug log/Easy|debug logging]]. Options: ''all'' (notification for updates of every single movie and episode), ''only info'' (default, only notification for major steps of the update process, ''only warning'', ''only error'', ''none'' (show no notifications at all)<br /> <br /> [[File:service_watchedlist_doc_settings_basic.jpg|500px|Basic Settings]]<br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in Kodi or edit this value manually in the &quot;%appdata%\Kodi\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. Set the number of backup files with this option. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. You can set this to infinite number of backups (option ''-1'') to make sure, but this will fill your disk over the years.<br /> # Dropbox synchronization: Saves your WatchedList database in your dropbox (should take max. 1MB space). If you enable this option, the [[Add-on:Dropbox|Dropbox authorization process]] will be started. If this option is activated with the same Dropbox account on several clients, it is possible to share the WatchedList database via the Dropbox.<br /> # Dropbox Auth Code: This will has to be inserted after the Dropbox authorization process (see above).<br /> # MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user.<br /> <br /> <br /> [[File:service_watchedlist_doc_settings_database.jpg|500px|Basic Settings]]<br /> <br /> === Useage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> * After Startup, the databases are searched for watched-information (Notification 1).<br /> * Then newly watched movies and tv episodes are written to the addon database (Notification 2). <br /> * After that, media that is not watched in the Kodi database and was previously marked as watched by the addon is again marked as watched in Kodi ( Notifications 3 and 4).<br /> <br /> &lt;gallery&gt;<br /> File:service_watchedlist_doc_notification_start.png|Notification 1<br /> File:service_watchedlist_doc_notification_remember.png|Notification 2<br /> File:service_watchedlist_doc_notification_setwatched_episode.png|Notification 3<br /> File:service_watchedlist_doc_notification_setwatched_movie.png|CNotification 4<br /> &lt;/gallery&gt;<br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> <br /> [[File:service_watchedlist_doc_mysql_watched_movies.jpg|500px|phpmyAdmin View of WatchedList database]]<br /> <br /> For the description of the tables read below.<br /> <br /> ==== SQLite Database file ====<br /> <br /> This Kodi Addon creates a SQLite database file called watchedlist.db by default. I recommend using the mySQL database instead, but both methods work well (see addon settings above).<br /> <br /> To view the database you can use the Windows Tool [https://sourceforge.net/projects/sqlitebrowser/files/latest/download SQLite Database Browser] or the Linux Tool [https://sourceforge.net/projects/sqliteman/ sqliteman]. The file is by default located in %APPDATA%\Kodi\userdata\addon_data\service.watchedlist\watchedlist.db in Windows or ~/.kodi/userdata/addon_data/service.watchedlist/watchedlist.db in Linux.<br /> <br /> This first figure shows the SQLite db file with automatically created backup copies.<br /> <br /> [[File:service_watchedlist_doc_db_folder.png|500px|File overview]]<br /> <br /> The database (here opened with SQLite DB Browser) has three tables. <br /> <br /> [[File:service_watchedlist_doc_sqlite_structure.png|500px|Database overview]]<br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_movies.png|500px|Movie table overview]]<br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in Kodi, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability.<br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_episode.png|500px|Episode table overview]]<br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, the possibility to use a mysql database was added. This has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database from SQLite db file to mysql:<br /> <br /> * open the old database file in SQLite database browser<br /> * File -&gt; Export -&gt; Database to sql file<br /> * bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO `movie_watched` VALUES \((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO `movie_watched` VALUES \((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO `episode_watched` VALUES \((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO `episode_watched` VALUES \((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> ::* The exact character sequence regarding white-spaces or backticks can be different between versions of the SQLite tool and might need adaptation<br /> * Save this new sql file<br /> * execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled.<br /> <br /> == Technical Details ==<br /> <br /> The Kodi Database is queried and updated with JSON-RPC. It should not matter whether you use Kodi mysql or Kodi local database.<br /> <br /> == Limitations ==<br /> <br /> The watched-status is only stored based on imdb/thetvdb number. Different Versions of a movie (DVD, BlueRay, Extended Edition, Directors Cut) are all considered equally watched.<br /> <br /> == Alternatives ==<br /> <br /> * Online List of watched movies<br /> ::* [[Add-on:Trakt|Trakt Addon]]<br /> ::* [https://forum.kodi.tv/showthread.php?tid=128542 Follw-It Addon] (Last update April 2012, probably not working any more) <br /> * Addon that exports the watched-state to the nfo files of the movies<br /> ::* [https://www.kodinerds.net/index.php/Thread/36207-Release-NFO-Watchedstate-Updater/|NFO Watchedstate Updater]<br /> * separate script to scan Kodi library (probably not executable from within Kodi and not working any more)<br /> ::* http://forum.kodi.tv/showthread.php?tid=62874&amp;pid=1280902#pid1280902 <br /> * other similar addons<br /> ::* http://forum.kodi.tv/showthread.php?tid=129448&amp;pid=1401643#pid1401643 (not working any more) <br /> * Export watched flag in nfo file and Import it back again:<br /> ::* [[AdvancedSettings.xml]] Section: Video Library<br /> <br /> == Feedback and Discussion ==<br /> <br /> In case of errors or questions, please post them [http://forum.kodi.tv/showthread.php?tid=164652 in the forum thread].<br /> <br /> [[Category:Add-ons with license tag]]<br /> [[Category:Add-ons with source tag]]<br /> [[Category:Add-ons with website tag]]<br /> [[Category:All add-ons]]<br /> [[Category:Program add-ons]]<br /> [[Category:Krypton add-on repository]]<br /> [[Category:Isengard add-on repository]]<br /> [[Category:Helix add-on repository]]<br /> [[Category:Leia add-on repository]]<br /> [[Category:Jarvis add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:Dropbox_API&diff=131264 2017-11-26T16:55:18Z

<p>Schapplm: reference to other page.</p> <hr /> <div>{{Addon <br /> |Name=Dropbox API<br /> |provider-name=micah<br /> |ID=script.module.dropbox<br /> |latest-version=2.2.2<br /> |extension point=xbmc.python.library<br /> |provides= <br /> |Summary=Provide Dropbox Python API support<br /> |Description=Provide Dropbox Python API support<br /> |Platform=all<br /> |Language=<br /> |License=Apache2<br /> |Forum=<br /> |Website=<br /> |Source=http://python-requests.org<br /> |Email=micahgalizia AT gmail.com<br /> |broken=<br /> |icon url=}}<br /> <br /> This wiki page is duplicate. See [[Add-on:Dropbox]] for the description and manual of the dropbox API in script.module.dropbox.<br /> <br /> [[Category:Add-on libraries/modules]]<br /> [[Category:Add-ons with license tag]]<br /> [[Category:Add-ons with source tag]]<br /> [[Category:All add-ons]]<br /> [[Category:Krypton add-on repository]]<br /> [[Category:Isengard add-on repository]]<br /> [[Category:Leia add-on repository]]<br /> [[Category:Jarvis add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=130045 2017-07-01T06:54:22Z

<p>Schapplm: /* SQLite Database file */ file location</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.1.2<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched Movies and TV Episodes independent from filenames<br /> |Description=<br /> Export: Searches the Kodi-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in Kodi.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991<br /> |Forum=http://forum.kodi.tv/showthread.php?tid=164652<br /> |Website=http://kodi.wiki/view/Add-on:WatchedList<br /> |Source=https://github.com/SchapplM/xbmc-addon-service-watchedlist<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/krypton/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with Kodi after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the WatchedList database every time the user changes a watched state (from unwatched to watched and vice versa). Marking something as &quot;unwatched&quot; is only possible with this setting.<br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible during the update (can take a few minutes, depending on verbosity and amount of changes and size of database), but it is possible to abort the whole process.<br /> # Amount of User Information (&quot;verbosity&quot;): Determines, for which events a notification will be shown. This is independent from [[Debug log/Easy|debug logging]]. Options: ''all'' (notification for updates of every single movie and episode), ''only info'' (default, only notification for major steps of the update process, ''only warning'', ''only error'', ''none'' (show no notifications at all)<br /> <br /> [[File:service_watchedlist_doc_settings_basic.jpg|500px|Basic Settings]]<br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in Kodi or edit this value manually in the &quot;%appdata%\Kodi\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. Set the number of backup files with this option. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. You can set this to infinite number of backups (option ''-1'') to make sure, but this will fill your disk over the years.<br /> # Dropbox synchronization: Saves your WatchedList database in your dropbox (should take max. 1MB space). If you enable this option, the [[Add-on:Dropbox|Dropbox authorization process]] will be started. If this option is activated with the same Dropbox account on several clients, it is possible to share the WatchedList database via the Dropbox.<br /> # Dropbox Auth Code: This will has to be inserted after the Dropbox authorization process (see above).<br /> # MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user.<br /> <br /> <br /> [[File:service_watchedlist_doc_settings_database.jpg|500px|Basic Settings]]<br /> <br /> === Useage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> * After Startup, the databases are searched for watched-information (Notification 1).<br /> * Then newly watched movies and tv episodes are written to the addon database (Notification 2). <br /> * After that, media that is not watched in the Kodi database and was previously marked as watched by the addon is again marked as watched in Kodi ( Notifications 3 and 4).<br /> <br /> &lt;gallery&gt;<br /> File:service_watchedlist_doc_notification_start.png|Notification 1<br /> File:service_watchedlist_doc_notification_remember.png|Notification 2<br /> File:service_watchedlist_doc_notification_setwatched_episode.png|Notification 3<br /> File:service_watchedlist_doc_notification_setwatched_movie.png|CNotification 4<br /> &lt;/gallery&gt;<br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> <br /> [[File:service_watchedlist_doc_mysql_watched_movies.jpg|500px|phpmyAdmin View of WatchedList database]]<br /> <br /> For the description of the tables read below.<br /> <br /> ==== SQLite Database file ====<br /> <br /> This Kodi Addon creates a SQLite database file called watchedlist.db by default. I recommend using the mySQL database instead, but both methods work well (see addon settings above).<br /> <br /> To view the database you can use the Windows Tool [https://sourceforge.net/projects/sqlitebrowser/files/latest/download SQLite Database Browser] or the Linux Tool [https://sourceforge.net/projects/sqliteman/ sqliteman]. The file is by default located in %APPDATA%\Kodi\userdata\addon_data\service.watchedlist\watchedlist.db in Windows or ~/.kodi/userdata/addon_data/service.watchedlist/watchedlist.db in Linux.<br /> <br /> This first figure shows the SQLite db file with automatically created backup copies.<br /> <br /> [[File:service_watchedlist_doc_db_folder.png|500px|File overview]]<br /> <br /> The database (here opened with SQLite DB Browser) has three tables. <br /> <br /> [[File:service_watchedlist_doc_sqlite_structure.png|500px|Database overview]]<br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_movies.png|500px|Movie table overview]]<br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in Kodi, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability.<br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_episode.png|500px|Episode table overview]]<br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, the possibility to use a mysql database was added. This has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database from SQLite db file to mysql:<br /> <br /> * open the old database file in SQLite database browser<br /> * File -&gt; Export -&gt; Database to sql file<br /> * bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO `movie_watched` VALUES \((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO `movie_watched` VALUES \((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO `episode_watched` VALUES \((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO `episode_watched` VALUES \((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> ::* The exact character sequence regarding white-spaces or backticks can be different between versions of the SQLite tool and might need adaptation<br /> * Save this new sql file<br /> * execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled.<br /> <br /> == Technical Details ==<br /> <br /> The Kodi Database is queried and updated with JSON-RPC. It should not matter whether you use Kodi mysql or Kodi local database.<br /> <br /> == Limitations ==<br /> <br /> The watched-status is only stored based on imdb/thetvdb number. Different Versions of a movie (DVD, BlueRay, Extended Edition, Directors Cut) are all considered equally watched.<br /> <br /> == Alternatives ==<br /> <br /> * Online List of watched movies<br /> ::* [[Add-on:Trakt|Trakt Add-on]]<br /> ::* http://code.google.com/p/xbmc-follwit/ (Last update April 2012, probably not Frodo-compatible) <br /> ::* ...<br /> * separate script to scan Kodi library (probably not executable from within Kodi)<br /> ::* http://forum.kodi.tv/showthread.php?tid=62874&amp;pid=1280902#pid1280902 <br /> * other similar addons<br /> ::* http://code.google.com/p/xbmc-watched-data/ (defect in Frodo?)<br /> ::* http://forum.kodi.tv/showthread.php?tid=129448&amp;pid=1401643#pid1401643 (working in Frodo, a little bug, because comparison of names instead of unique numbers) <br /> * Export watched flag in nfo file and Import it back again:<br /> ::* [[AdvancedSettings.xml]] Section: Video Library<br /> <br /> <br /> == Feedback and Discussion ==<br /> <br /> In case of errors or questions, please post them [http://forum.kodi.tv/showthread.php?tid=164652 in the forum thread].<br /> <br /> [[Category:Add-ons with license tag]]<br /> [[Category:Add-ons with source tag]]<br /> [[Category:Add-ons with website tag]]<br /> [[Category:All add-ons]]<br /> [[Category:Program add-ons]]<br /> [[Category:Krypton add-on repository]]<br /> [[Category:Isengard add-on repository]]<br /> [[Category:Helix add-on repository]]<br /> [[Category:Leia add-on repository]]<br /> [[Category:Jarvis add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=130044 2017-07-01T06:50:09Z

<p>Schapplm: /* SQLite Database file */</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.1.2<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched Movies and TV Episodes independent from filenames<br /> |Description=<br /> Export: Searches the Kodi-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in Kodi.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991<br /> |Forum=http://forum.kodi.tv/showthread.php?tid=164652<br /> |Website=http://kodi.wiki/view/Add-on:WatchedList<br /> |Source=https://github.com/SchapplM/xbmc-addon-service-watchedlist<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/krypton/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with Kodi after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the WatchedList database every time the user changes a watched state (from unwatched to watched and vice versa). Marking something as &quot;unwatched&quot; is only possible with this setting.<br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible during the update (can take a few minutes, depending on verbosity and amount of changes and size of database), but it is possible to abort the whole process.<br /> # Amount of User Information (&quot;verbosity&quot;): Determines, for which events a notification will be shown. This is independent from [[Debug log/Easy|debug logging]]. Options: ''all'' (notification for updates of every single movie and episode), ''only info'' (default, only notification for major steps of the update process, ''only warning'', ''only error'', ''none'' (show no notifications at all)<br /> <br /> [[File:service_watchedlist_doc_settings_basic.jpg|500px|Basic Settings]]<br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in Kodi or edit this value manually in the &quot;%appdata%\Kodi\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. Set the number of backup files with this option. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. You can set this to infinite number of backups (option ''-1'') to make sure, but this will fill your disk over the years.<br /> # Dropbox synchronization: Saves your WatchedList database in your dropbox (should take max. 1MB space). If you enable this option, the [[Add-on:Dropbox|Dropbox authorization process]] will be started. If this option is activated with the same Dropbox account on several clients, it is possible to share the WatchedList database via the Dropbox.<br /> # Dropbox Auth Code: This will has to be inserted after the Dropbox authorization process (see above).<br /> # MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user.<br /> <br /> <br /> [[File:service_watchedlist_doc_settings_database.jpg|500px|Basic Settings]]<br /> <br /> === Useage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> * After Startup, the databases are searched for watched-information (Notification 1).<br /> * Then newly watched movies and tv episodes are written to the addon database (Notification 2). <br /> * After that, media that is not watched in the Kodi database and was previously marked as watched by the addon is again marked as watched in Kodi ( Notifications 3 and 4).<br /> <br /> &lt;gallery&gt;<br /> File:service_watchedlist_doc_notification_start.png|Notification 1<br /> File:service_watchedlist_doc_notification_remember.png|Notification 2<br /> File:service_watchedlist_doc_notification_setwatched_episode.png|Notification 3<br /> File:service_watchedlist_doc_notification_setwatched_movie.png|CNotification 4<br /> &lt;/gallery&gt;<br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> <br /> [[File:service_watchedlist_doc_mysql_watched_movies.jpg|500px|phpmyAdmin View of WatchedList database]]<br /> <br /> For the description of the tables read below.<br /> <br /> ==== SQLite Database file ====<br /> <br /> This Kodi Addon creates a SQLite database file called watchedlist.db by default. I recommend using the mySQL database instead, but both methods work well (see addon settings above).<br /> <br /> To view the database you can use the Windows Tool [https://sourceforge.net/projects/sqlitebrowser/files/latest/download SQLite Database Browser] or the Linux Tool [https://sourceforge.net/projects/sqliteman/ sqliteman].<br /> <br /> This first figure shows the SQLite db file with automatically created backup copies.<br /> <br /> [[File:service_watchedlist_doc_db_folder.png|500px|File overview]]<br /> <br /> The database (here openened with SQLite DB Browser) has three tables. <br /> <br /> [[File:service_watchedlist_doc_sqlite_structure.png|500px|Database overview]]<br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_movies.png|500px|Movie table overview]]<br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in Kodi, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability.<br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_episode.png|500px|Episode table overview]]<br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, the possibility to use a mysql database was added. This has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database from SQLite db file to mysql:<br /> <br /> * open the old database file in SQLite database browser<br /> * File -&gt; Export -&gt; Database to sql file<br /> * bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO `movie_watched` VALUES \((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO `movie_watched` VALUES \((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO `episode_watched` VALUES \((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO `episode_watched` VALUES \((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> ::* The exact character sequence regarding white-spaces or backticks can be different between versions of the SQLite tool and might need adaptation<br /> * Save this new sql file<br /> * execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled.<br /> <br /> == Technical Details ==<br /> <br /> The Kodi Database is queried and updated with JSON-RPC. It should not matter whether you use Kodi mysql or Kodi local database.<br /> <br /> == Limitations ==<br /> <br /> The watched-status is only stored based on imdb/thetvdb number. Different Versions of a movie (DVD, BlueRay, Extended Edition, Directors Cut) are all considered equally watched.<br /> <br /> == Alternatives ==<br /> <br /> * Online List of watched movies<br /> ::* [[Add-on:Trakt|Trakt Add-on]]<br /> ::* http://code.google.com/p/xbmc-follwit/ (Last update April 2012, probably not Frodo-compatible) <br /> ::* ...<br /> * separate script to scan Kodi library (probably not executable from within Kodi)<br /> ::* http://forum.kodi.tv/showthread.php?tid=62874&amp;pid=1280902#pid1280902 <br /> * other similar addons<br /> ::* http://code.google.com/p/xbmc-watched-data/ (defect in Frodo?)<br /> ::* http://forum.kodi.tv/showthread.php?tid=129448&amp;pid=1401643#pid1401643 (working in Frodo, a little bug, because comparison of names instead of unique numbers) <br /> * Export watched flag in nfo file and Import it back again:<br /> ::* [[AdvancedSettings.xml]] Section: Video Library<br /> <br /> <br /> == Feedback and Discussion ==<br /> <br /> In case of errors or questions, please post them [http://forum.kodi.tv/showthread.php?tid=164652 in the forum thread].<br /> <br /> [[Category:Add-ons with license tag]]<br /> [[Category:Add-ons with source tag]]<br /> [[Category:Add-ons with website tag]]<br /> [[Category:All add-ons]]<br /> [[Category:Program add-ons]]<br /> [[Category:Krypton add-on repository]]<br /> [[Category:Isengard add-on repository]]<br /> [[Category:Helix add-on repository]]<br /> [[Category:Leia add-on repository]]<br /> [[Category:Jarvis add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=129452 2017-04-28T15:11:18Z

<p>Schapplm: xbmc -&gt; kodi</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.1.2<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched Movies and TV Episodes independent from filenames<br /> |Description=<br /> Export: Searches the Kodi-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in Kodi.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991<br /> |Forum=http://forum.kodi.tv/showthread.php?tid=164652<br /> |Website=http://kodi.wiki/view/Add-on:WatchedList<br /> |Source=https://github.com/SchapplM/xbmc-addon-service-watchedlist<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/krypton/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with Kodi after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the WatchedList database every time the user changes a watched state (from unwatched to watched and vice versa). Marking something as &quot;unwatched&quot; is only possible with this setting.<br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible during the update (can take a few minutes, depending on verbosity and amount of changes and size of database), but it is possible to abort the whole process.<br /> # Amount of User Information (&quot;verbosity&quot;): Determines, for which events a notification will be shown. This is independent from [[Debug log/Easy|debug logging]]. Options: ''all'' (notification for updates of every single movie and episode), ''only info'' (default, only notification for major steps of the update process, ''only warning'', ''only error'', ''none'' (show no notifications at all)<br /> <br /> [[File:service_watchedlist_doc_settings_basic.jpg|500px|Basic Settings]]<br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in Kodi or edit this value manually in the &quot;%appdata%\Kodi\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. Set the number of backup files with this option. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. You can set this to infinite number of backups (option ''-1'') to make sure, but this will fill your disk over the years.<br /> # Dropbox synchronization: Saves your WatchedList database in your dropbox (should take max. 1MB space). If you enable this option, the [[Add-on:Dropbox|Dropbox authorization process]] will be started. If this option is activated with the same Dropbox account on several clients, it is possible to share the WatchedList database via the Dropbox.<br /> # Dropbox Auth Code: This will has to be inserted after the Dropbox authorization process (see above).<br /> # MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user.<br /> <br /> <br /> [[File:service_watchedlist_doc_settings_database.jpg|500px|Basic Settings]]<br /> <br /> === Useage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> * After Startup, the databases are searched for watched-information (Notification 1).<br /> * Then newly watched movies and tv episodes are written to the addon database (Notification 2). <br /> * After that, media that is not watched in the Kodi database and was previously marked as watched by the addon is again marked as watched in Kodi ( Notifications 3 and 4).<br /> <br /> &lt;gallery&gt;<br /> File:service_watchedlist_doc_notification_start.png|Notification 1<br /> File:service_watchedlist_doc_notification_remember.png|Notification 2<br /> File:service_watchedlist_doc_notification_setwatched_episode.png|Notification 3<br /> File:service_watchedlist_doc_notification_setwatched_movie.png|CNotification 4<br /> &lt;/gallery&gt;<br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> <br /> [[File:service_watchedlist_doc_mysql_watched_movies.jpg|500px|phpmyAdmin View of WatchedList database]]<br /> <br /> For the description of the tables read below.<br /> <br /> ==== SQLite Database file ====<br /> <br /> The SQLite Database file option is no longer recommended. To transfer an existing SQLite WatchedList? Database, read below.<br /> <br /> The script creates a SQLite database. To view the database I used SQLite Database Browser. <br /> <br /> https://sourceforge.net/projects/sqlitebrowser/files/latest/download<br /> <br /> This figure shows the SQLite db file with automatically created backup copies.<br /> <br /> [[File:service_watchedlist_doc_db_folder.png|500px|File overview]]<br /> <br /> The database has three tables. <br /> <br /> [[File:service_watchedlist_doc_sqlite_structure.png|500px|Database overview]]<br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_movies.png|500px|Movie table overview]]<br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in Kodi, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability.<br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_episode.png|500px|Episode table overview]]<br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, the possibility to use a mysql database was added. This has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database from SQLite db file to mysql:<br /> <br /> * open the old database file in SQLite database browser<br /> * File -&gt; Export -&gt; Database to sql file<br /> * bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO `movie_watched` VALUES \((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO `movie_watched` VALUES \((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO `episode_watched` VALUES \((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO `episode_watched` VALUES \((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> ::* The exact character sequence regarding white-spaces or backticks can be different between versions of the SQLite tool and might need adaptation<br /> * Save this new sql file<br /> * execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled.<br /> <br /> == Technical Details ==<br /> <br /> The Kodi Database is queried and updated with JSON-RPC. It should not matter whether you use Kodi mysql or Kodi local database.<br /> <br /> == Limitations ==<br /> <br /> The watched-status is only stored based on imdb/thetvdb number. Different Versions of a movie (DVD, BlueRay, Extended Edition, Directors Cut) are all considered equally watched.<br /> <br /> == Alternatives ==<br /> <br /> * Online List of watched movies<br /> ::* [[Add-on:Trakt|Trakt Add-on]]<br /> ::* http://code.google.com/p/xbmc-follwit/ (Last update April 2012, probably not Frodo-compatible) <br /> ::* ...<br /> * separate script to scan Kodi library (probably not executable from within Kodi)<br /> ::* http://forum.kodi.tv/showthread.php?tid=62874&amp;pid=1280902#pid1280902 <br /> * other similar addons<br /> ::* http://code.google.com/p/xbmc-watched-data/ (defect in Frodo?)<br /> ::* http://forum.kodi.tv/showthread.php?tid=129448&amp;pid=1401643#pid1401643 (working in Frodo, a little bug, because comparison of names instead of unique numbers) <br /> * Export watched flag in nfo file and Import it back again:<br /> ::* [[AdvancedSettings.xml]] Section: Video Library<br /> <br /> <br /> == Feedback and Discussion ==<br /> <br /> In case of errors or questions, please post them [http://forum.kodi.tv/showthread.php?tid=164652 in the forum thread].<br /> <br /> [[Category:Add-ons with license tag]]<br /> [[Category:Add-ons with source tag]]<br /> [[Category:Add-ons with website tag]]<br /> [[Category:All add-ons]]<br /> [[Category:Program add-ons]]<br /> [[Category:Krypton add-on repository]]<br /> [[Category:Isengard add-on repository]]<br /> [[Category:Helix add-on repository]]<br /> [[Category:Leia add-on repository]]<br /> [[Category:Jarvis add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=129451 2017-04-28T15:07:51Z

<p>Schapplm: Updated settings to new version</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.1.2<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched Movies and TV Episodes independent from filenames<br /> |Description=<br /> Export: Searches the Kodi-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in Kodi.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991<br /> |Forum=http://forum.kodi.tv/showthread.php?tid=164652<br /> |Website=http://kodi.wiki/view/Add-on:WatchedList<br /> |Source=https://github.com/SchapplM/xbmc-addon-service-watchedlist<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/krypton/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with Kodi after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the WatchedList database every time the user changes a watched state (from unwatched to watched and vice versa). Marking something as &quot;unwatched&quot; is only possible with this setting.<br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible during the update (can take a few minutes, depending on verbosity and amount of changes and size of database), but it is possible to abort the whole process.<br /> # Amount of User Information (&quot;verbosity&quot;): Determines, for which events a notification will be shown. This is independent from [[Debug log/Easy|debug logging]]. Options: ''all'' (notification for updates of every single movie and episode), ''only info'' (default, only notification for major steps of the update process, ''only warning'', ''only error'', ''none'' (show no notifications at all)<br /> <br /> [[File:service_watchedlist_doc_settings_basic.jpg|500px|Basic Settings]]<br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in xbmc or edit this value manually in the &quot;%appdata%\XBMC\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. Set the number of backup files with this option. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. You can set this to infinite number of backups (option ''-1'') to make sure, but this will fill your disk over the years.<br /> # Dropbox synchronization: Saves your WatchedList database in your dropbox (should take max. 1MB space). If you enable this option, the [[Add-on:Dropbox|Dropbox authorization process]] will be started. If this option is activated with the same Dropbox account on several clients, it is possible to share the WatchedList database via the Dropbox.<br /> # Dropbox Auth Code: This will has to be inserted after the Dropbox authorization process (see above).<br /> # MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user.<br /> <br /> <br /> [[File:service_watchedlist_doc_settings_database.jpg|500px|Basic Settings]]<br /> <br /> === Useage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> * After Startup, the databases are searched for watched-information (Notification 1).<br /> * Then newly watched movies and tv episodes are written to the addon database (Notification 2). <br /> * After that, media that is not watched in the Kodi database and was previously marked as watched by the addon is again marked as watched in Kodi ( Notifications 3 and 4).<br /> <br /> &lt;gallery&gt;<br /> File:service_watchedlist_doc_notification_start.png|Notification 1<br /> File:service_watchedlist_doc_notification_remember.png|Notification 2<br /> File:service_watchedlist_doc_notification_setwatched_episode.png|Notification 3<br /> File:service_watchedlist_doc_notification_setwatched_movie.png|CNotification 4<br /> &lt;/gallery&gt;<br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> <br /> [[File:service_watchedlist_doc_mysql_watched_movies.jpg|500px|phpmyAdmin View of WatchedList database]]<br /> <br /> For the description of the tables read below.<br /> <br /> ==== SQLite Database file ====<br /> <br /> The SQLite Database file option is no longer recommended. To transfer an existing SQLite WatchedList? Database, read below.<br /> <br /> The script creates a SQLite database. To view the database I used SQLite Database Browser. <br /> <br /> https://sourceforge.net/projects/sqlitebrowser/files/latest/download<br /> <br /> This figure shows the SQLite db file with automatically created backup copies.<br /> <br /> [[File:service_watchedlist_doc_db_folder.png|500px|File overview]]<br /> <br /> The database has three tables. <br /> <br /> [[File:service_watchedlist_doc_sqlite_structure.png|500px|Database overview]]<br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_movies.png|500px|Movie table overview]]<br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in XBMC, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability.<br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_episode.png|500px|Episode table overview]]<br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, the possibility to use a mysql database was added. This has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database from SQLite db file to mysql:<br /> <br /> * open the old database file in SQLite database browser<br /> * File -&gt; Export -&gt; Database to sql file<br /> * bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO `movie_watched` VALUES \((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO `movie_watched` VALUES \((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO `episode_watched` VALUES \((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO `episode_watched` VALUES \((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> ::* The exact character sequence regarding white-spaces or backticks can be different between versions of the SQLite tool and might need adaptation<br /> * Save this new sql file<br /> * execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled.<br /> <br /> == Technical Details ==<br /> <br /> The XBMC Database is queried and updated with JSON-RPC. It should not matter whether you use xbmc mysql or xbmc local database.<br /> <br /> == Limitations ==<br /> <br /> The watched-status is only stored based on imdb/thetvdb number. Different Versions of a movie (DVD, BlueRay, Extended Edition, Directors Cut) are all considered equally watched.<br /> <br /> == Alternatives ==<br /> <br /> * Online List of watched movies<br /> ::* [[Add-on:Trakt|Trakt Add-on]]<br /> ::* http://code.google.com/p/xbmc-follwit/ (Last update April 2012, probably not Frodo-compatible) <br /> ::* ...<br /> * separate script to scan xbmc library (probably not executable from within xbmc)<br /> ::* http://forum.kodi.tv/showthread.php?tid=62874&amp;pid=1280902#pid1280902 <br /> * other similar addons<br /> ::* http://code.google.com/p/xbmc-watched-data/ (defect in Frodo?)<br /> ::* http://forum.kodi.tv/showthread.php?tid=129448&amp;pid=1401643#pid1401643 (working in Frodo, a little bug, because comparison of names instead of unique numbers) <br /> * Export watched flag in nfo file and Import it back again:<br /> ::* http://wiki.xbmc.org/index.php?title=Advancedsettings.xml#.3Cvideolibrary.3E<br /> <br /> == Feedback and Discussion ==<br /> <br /> In case of errors or questions, please post them [http://forum.kodi.tv/showthread.php?tid=164652 in the forum thread].<br /> <br /> [[Category:Add-ons with license tag]]<br /> [[Category:Add-ons with source tag]]<br /> [[Category:Add-ons with website tag]]<br /> [[Category:All add-ons]]<br /> [[Category:Program add-ons]]<br /> [[Category:Krypton add-on repository]]<br /> [[Category:Isengard add-on repository]]<br /> [[Category:Helix add-on repository]]<br /> [[Category:Leia add-on repository]]<br /> [[Category:Jarvis add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=129450 2017-04-28T14:29:12Z

<p>Schapplm: /* Alternatives */</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.1.2<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched Movies and TV Episodes independent from filenames<br /> |Description=<br /> Export: Searches the Kodi-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in Kodi.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991<br /> |Forum=http://forum.kodi.tv/showthread.php?tid=164652<br /> |Website=http://kodi.wiki/view/Add-on:WatchedList<br /> |Source=https://github.com/SchapplM/xbmc-addon-service-watchedlist<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/krypton/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Debug mode: Show more notifications, create more entries in kodi.log <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with XBMC after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the watchedlist database every time the user changes a watched state <br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible in this time.<br /> <br /> [[File:service_watchedlist_doc_settings_basic.jpg|500px|Basic Settings]]<br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. I recommend a mysql database, since there were problems with the SQLite database file consistency since XBMC v13. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in xbmc or edit this value manually in the &quot;%appdata%\XBMC\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. On the contrary the directory will be filled with new files on every change to the WL-DB (no file Rotation, drive space). <br /> # MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user.<br /> <br /> <br /> [[File:service_watchedlist_doc_settings_database.jpg|500px|Basic Settings]]<br /> <br /> === Useage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> * After Startup, the databases are searched for watched-information (Notification 1).<br /> * Then newly watched movies and tv episodes are written to the addon database (Notification 2). <br /> * After that, media that is not watched in the Kodi database and was previously marked as watched by the addon is again marked as watched in Kodi ( Notifications 3 and 4).<br /> <br /> &lt;gallery&gt;<br /> File:service_watchedlist_doc_notification_start.png|Notification 1<br /> File:service_watchedlist_doc_notification_remember.png|Notification 2<br /> File:service_watchedlist_doc_notification_setwatched_episode.png|Notification 3<br /> File:service_watchedlist_doc_notification_setwatched_movie.png|CNotification 4<br /> &lt;/gallery&gt;<br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> <br /> [[File:service_watchedlist_doc_mysql_watched_movies.jpg|500px|phpmyAdmin View of WatchedList database]]<br /> <br /> For the description of the tables read below.<br /> <br /> ==== SQLite Database file ====<br /> <br /> The SQLite Database file option is no longer recommended. To transfer an existing SQLite WatchedList? Database, read below.<br /> <br /> The script creates a SQLite database. To view the database I used SQLite Database Browser. <br /> <br /> https://sourceforge.net/projects/sqlitebrowser/files/latest/download<br /> <br /> This figure shows the SQLite db file with automatically created backup copies.<br /> <br /> [[File:service_watchedlist_doc_db_folder.png|500px|File overview]]<br /> <br /> The database has three tables. <br /> <br /> [[File:service_watchedlist_doc_sqlite_structure.png|500px|Database overview]]<br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_movies.png|500px|Movie table overview]]<br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in XBMC, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability.<br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_episode.png|500px|Episode table overview]]<br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, the possibility to use a mysql database was added. This has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database from SQLite db file to mysql:<br /> <br /> * open the old database file in SQLite database browser<br /> * File -&gt; Export -&gt; Database to sql file<br /> * bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO `movie_watched` VALUES \((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO `movie_watched` VALUES \((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO `episode_watched` VALUES \((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO `episode_watched` VALUES \((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> ::* The exact character sequence regarding white-spaces or backticks can be different between versions of the SQLite tool and might need adaptation<br /> * Save this new sql file<br /> * execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled.<br /> <br /> == Technical Details ==<br /> <br /> The XBMC Database is queried and updated with JSON-RPC. It should not matter whether you use xbmc mysql or xbmc local database.<br /> <br /> == Limitations ==<br /> <br /> The watched-status is only stored based on imdb/thetvdb number. Different Versions of a movie (DVD, BlueRay, Extended Edition, Directors Cut) are all considered equally watched.<br /> <br /> == Alternatives ==<br /> <br /> * Online List of watched movies<br /> ::* [[Add-on:Trakt|Trakt Add-on]]<br /> ::* http://code.google.com/p/xbmc-follwit/ (Last update April 2012, probably not Frodo-compatible) <br /> ::* ...<br /> * separate script to scan xbmc library (probably not executable from within xbmc)<br /> ::* http://forum.kodi.tv/showthread.php?tid=62874&amp;pid=1280902#pid1280902 <br /> * other similar addons<br /> ::* http://code.google.com/p/xbmc-watched-data/ (defect in Frodo?)<br /> ::* http://forum.kodi.tv/showthread.php?tid=129448&amp;pid=1401643#pid1401643 (working in Frodo, a little bug, because comparison of names instead of unique numbers) <br /> * Export watched flag in nfo file and Import it back again:<br /> ::* http://wiki.xbmc.org/index.php?title=Advancedsettings.xml#.3Cvideolibrary.3E<br /> <br /> == Feedback and Discussion ==<br /> <br /> In case of errors or questions, please post them [http://forum.kodi.tv/showthread.php?tid=164652 in the forum thread].<br /> <br /> [[Category:Add-ons with license tag]]<br /> [[Category:Add-ons with source tag]]<br /> [[Category:Add-ons with website tag]]<br /> [[Category:All add-ons]]<br /> [[Category:Program add-ons]]<br /> [[Category:Krypton add-on repository]]<br /> [[Category:Isengard add-on repository]]<br /> [[Category:Helix add-on repository]]<br /> [[Category:Leia add-on repository]]<br /> [[Category:Jarvis add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=127039 2017-01-22T21:01:30Z

<p>Schapplm: http://forum.kodi.tv/showthread.php?tid=164652&amp;pid=2506723#pid2506723</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.1.2<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched Movies and TV Episodes independent from filenames<br /> |Description=<br /> Export: Searches the Kodi-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in Kodi.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991<br /> |Forum=http://forum.kodi.tv/showthread.php?tid=164652<br /> |Website=http://kodi.wiki/view/Add-on:WatchedList<br /> |Source=https://github.com/SchapplM/xbmc-addon-service-watchedlist<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/krypton/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Debug mode: Show more notifications, create more entries in kodi.log <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with XBMC after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the watchedlist database every time the user changes a watched state <br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible in this time.<br /> <br /> [[File:service_watchedlist_doc_settings_basic.jpg|500px|Basic Settings]]<br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. I recommend a mysql database, since there were problems with the SQLite database file consistency since XBMC v13. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in xbmc or edit this value manually in the &quot;%appdata%\XBMC\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. On the contrary the directory will be filled with new files on every change to the WL-DB (no file Rotation, drive space). <br /> # MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user.<br /> <br /> <br /> [[File:service_watchedlist_doc_settings_database.jpg|500px|Basic Settings]]<br /> <br /> === Useage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> * After Startup, the databases are searched for watched-information (Notification 1).<br /> * Then newly watched movies and tv episodes are written to the addon database (Notification 2). <br /> * After that, media that is not watched in the Kodi database and was previously marked as watched by the addon is again marked as watched in Kodi ( Notifications 3 and 4).<br /> <br /> &lt;gallery&gt;<br /> File:service_watchedlist_doc_notification_start.png|Notification 1<br /> File:service_watchedlist_doc_notification_remember.png|Notification 2<br /> File:service_watchedlist_doc_notification_setwatched_episode.png|Notification 3<br /> File:service_watchedlist_doc_notification_setwatched_movie.png|CNotification 4<br /> &lt;/gallery&gt;<br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> <br /> [[File:service_watchedlist_doc_mysql_watched_movies.jpg|500px|phpmyAdmin View of WatchedList database]]<br /> <br /> For the description of the tables read below.<br /> <br /> ==== SQLite Database file ====<br /> <br /> The SQLite Database file option is no longer recommended. To transfer an existing SQLite WatchedList? Database, read below.<br /> <br /> The script creates a SQLite database. To view the database I used SQLite Database Browser. <br /> <br /> https://sourceforge.net/projects/sqlitebrowser/files/latest/download<br /> <br /> This figure shows the SQLite db file with automatically created backup copies.<br /> <br /> [[File:service_watchedlist_doc_db_folder.png|500px|File overview]]<br /> <br /> The database has three tables. <br /> <br /> [[File:service_watchedlist_doc_sqlite_structure.png|500px|Database overview]]<br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_movies.png|500px|Movie table overview]]<br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in XBMC, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability.<br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_episode.png|500px|Episode table overview]]<br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, the possibility to use a mysql database was added. This has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database from SQLite db file to mysql:<br /> <br /> * open the old database file in SQLite database browser<br /> * File -&gt; Export -&gt; Database to sql file<br /> * bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO `movie_watched` VALUES \((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO `movie_watched` VALUES \((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO `episode_watched` VALUES \((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO `episode_watched` VALUES \((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> ::* The exact character sequence regarding white-spaces or backticks can be different between versions of the SQLite tool and might need adaptation<br /> * Save this new sql file<br /> * execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled.<br /> <br /> == Technical Details ==<br /> <br /> The XBMC Database is queried and updated with JSON-RPC. It should not matter whether you use xbmc mysql or xbmc local database.<br /> <br /> == Limitations ==<br /> <br /> The watched-status is only stored based on imdb/thetvdb number. Different Versions of a movie (DVD, BlueRay, Extended Edition, Directors Cut) are all considered equally watched.<br /> <br /> == Alternatives ==<br /> <br /> * Online List of watched movies<br /> ::* http://code.google.com/p/xbmc-follwit/ (Last update April 2012, probably not Frodo-compatible) <br /> ::* ...<br /> * separate script to scan xbmc library (probably not executable from within xbmc)<br /> ::* http://forum.kodi.tv/showthread.php?tid=62874&amp;pid=1280902#pid1280902 <br /> * other similar addons<br /> ::* http://code.google.com/p/xbmc-watched-data/ (defect in Frodo?)<br /> ::* http://forum.kodi.tv/showthread.php?tid=129448&amp;pid=1401643#pid1401643 (working in Frodo, a little bug, because comparison of names instead of unique numbers) <br /> * Export watched flag in nfo file and Import it back again:<br /> ::* http://wiki.xbmc.org/index.php?title=Advancedsettings.xml#.3Cvideolibrary.3E <br /> <br /> == Feedback and Discussion ==<br /> <br /> In case of errors or questions, please post them [http://forum.kodi.tv/showthread.php?tid=164652 in the forum thread].<br /> <br /> [[Category:Add-ons with license tag]]<br /> [[Category:Add-ons with source tag]]<br /> [[Category:Add-ons with website tag]]<br /> [[Category:All add-ons]]<br /> [[Category:Program add-ons]]<br /> [[Category:Krypton add-on repository]]<br /> [[Category:Isengard add-on repository]]<br /> [[Category:Helix add-on repository]]<br /> [[Category:Jarvis add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:Dropbox&diff=120180 2016-04-10T17:54:49Z

<p>Schapplm: manual how to use the addon</p> <hr /> <div>{{Addon <br /> |Name=dropbox<br /> |provider-name=micah<br /> |ID=script.module.dropbox<br /> |latest-version=2.2.0<br /> |extension point=xbmc.python.module<br /> |provides=<br /> |Summary=Provide Dropbox Python API support<br /> |Description=Provide Dropbox Python API support<br /> |Platform=all<br /> |Language=<br /> |License=Apache2<br /> |Forum=<br /> |Website=<br /> |Source=http://python-requests.org<br /> |Email=micahgalizia AT gmail.com<br /> |broken=<br /> |icon url=}}<br /> <br /> [[Category:Isengard add-on repository]]<br /> [[Category:Jarvis add-on repository]]<br /> <br /> <br /> = Installation =<br /> <br /> This addon does not have to be installed: It is a prerequisite for other addons and will be installed automatically when installing these other addons.<br /> <br /> = About the Addon = <br /> <br /> This addon provides access to the dropbox API to other addons. Addons registered as Dropbox Apps have a separate folder in the dropbox file structure and can access files only in this folder.<br /> This addon does not provide access to the files in the general dropbox file system.<br /> The addon is triggered by opening a settings field in an addon using the Dropbox API.<br /> <br /> = Useage = <br /> <br /> * By opening the settings field &quot;dropbox authorization code&quot; from another addon, a link is displayed<br /> <br /> == Method A ==<br /> <br /> * open the link by using a QR code reader app on your smartphone ( in a browser on your smartphone)<br /> * enter your dropbox credentials and confirm<br /> * copy the authorization code<br /> * click next on your Kodi device<br /> * use a remote control smartphone app (like YATSE) to paste the authorization code into the dialog<br /> * click next in the Kodi dialog<br /> <br /> == Method B ==<br /> <br /> * open the link manually in a browser<br /> * type the authorization code with your keyboard in the Kodi dialog (Kodi does not support copy-paste, since it is designed for no-input-devices)</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:YouTube&diff=106011 2015-11-25T22:19:12Z

<p>Schapplm: restored deleted information from &quot;18:01, 8 April 2015‎&quot;</p> <hr /> <div>{{Addon <br /> |Name=YouTube<br /> |provider-name=bromix<br /> |ID=plugin.video.youtube<br /> |latest-version=5.1.10<br /> |extension point=xbmc.python.pluginsource<br /> |provides=video<br /> |Summary=Plugin for YouTube<br /> |Description=YouTube is a one of the biggest video-sharing websites of the world.<br /> |Platform=all<br /> |Language=<br /> |License=GNU GENERAL PUBLIC LICENSE. Version 2, June 1991<br /> |Forum=http://forum.kodi.tv/showthread.php?tid=200735<br /> |Website=http://www.youtube.com<br /> |Source=https://github.com/bromix/plugin.video.youtube<br /> |Email=bromix at gmx dot net<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/jarvis/plugin.video.youtube/icon.png}}<br /> <br /> <br /> == Features ==<br /> <br /> === Integration with strm files ===<br /> Youtube streams can be integrated into the video library with [[Strm|strm files]]. <br /> <br /> The syntax for a youtube-URL like &lt;nowiki&gt;https://www.youtube.com/watch?v=$VIDEOID&lt;/nowiki&gt; or &lt;nowiki&gt;https://www.youtube.com/playlist?list=$PLAYLISTID&lt;/nowiki&gt; in a strm file is&lt;br /&gt;<br /> <br /> &lt;code&gt;plugin://plugin.video.youtube/?path=/root/video&amp;action=play_video&amp;videoid=$VIDEOID&lt;/code&gt;<br /> <br /> &lt;code&gt;plugin://plugin.video.youtube/?path=/root/video&amp;action=play_all&amp;playlist=$PLAYLISTID&lt;/code&gt;<br /> <br /> <br /> == See also ==<br /> === Similar page names ===<br /> {{#lst:YouTube|similar pages}}<br /> <br /> [[Category:Social media]]<br /> [[Category:Helix add-on repository]]<br /> [[Category:Jarvis add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=84614 2015-01-31T17:45:40Z

<p>Schapplm: added forum link</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.0.3<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched Movies and TV Episodes independent from filenames<br /> |Description=<br /> Export: Searches the XBMC-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in xbmc.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=<br /> |Forum=<br /> |Website=<br /> |Source=<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/helix/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Debug mode: Show more notifications, create more entries in kodi.log <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with XBMC after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the watchedlist database every time the user changes a watched state <br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible in this time.<br /> <br /> [[File:service_watchedlist_doc_settings_basic.jpg|500px|Basic Settings]]<br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. I recommend a mysql database, since there were problems with the SQLite database file consistency since XBMC v13. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in xbmc or edit this value manually in the &quot;%appdata%\XBMC\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. On the contrary the directory will be filled with new files on every change to the WL-DB (no file Rotation, drive space). <br /> # MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user.<br /> <br /> <br /> [[File:service_watchedlist_doc_settings_database.jpg|500px|Basic Settings]]<br /> <br /> === Useage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> * After Startup, the databases are searched for watched-information (Notification 1).<br /> * Then newly watched movies and tv episodes are written to the addon database (Notification 2). <br /> * After that, media that is not watched in the Kodi database and was previously marked as watched by the addon is again marked as watched in Kodi ( Notifications 3 and 4).<br /> <br /> &lt;gallery&gt;<br /> File:service_watchedlist_doc_notification_start.png|Notification 1<br /> File:service_watchedlist_doc_notification_remember.png|Notification 2<br /> File:service_watchedlist_doc_notification_setwatched_episode.png|Notification 3<br /> File:service_watchedlist_doc_notification_setwatched_movie.png|CNotification 4<br /> &lt;/gallery&gt;<br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> <br /> [[File:service_watchedlist_doc_mysql_watched_movies.jpg|500px|phpmyAdmin View of WatchedList database]]<br /> <br /> For the description of the tables read below.<br /> <br /> ==== SQLite Database file ==== <br /> <br /> The SQLite Database file option is no longer recommended. To transfer an existing SQLite WatchedList? Database, read below.<br /> <br /> The script creates a SQLite database. To view the database I used SQLite Database Browser. <br /> <br /> https://sourceforge.net/projects/sqlitebrowser/files/latest/download<br /> <br /> This figure shows the SQLite db file with automatically created backup copies.<br /> <br /> [[File:service_watchedlist_doc_db_folder.png|500px|File overview]]<br /> <br /> The database has three tables. <br /> <br /> [[File:service_watchedlist_doc_sqlite_structure.png|500px|Database overview]]<br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_movies.png|500px|Movie table overview]]<br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in XBMC, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability.<br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_episode.png|500px|Episode table overview]]<br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, the possibility to use a mysql database was added. This has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database from SQLite db file to mysql:<br /> <br /> * open the old database file in SQLite database browser<br /> * File -&gt; Export -&gt; Database to sql file<br /> * bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO movie_watched VALUES\((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO movie_watched VALUES\((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO episode_watched VALUES\((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO episode_watched VALUES\((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> * Save this new sql file<br /> * execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled. <br /> <br /> == Technical Details ==<br /> <br /> The XBMC Database is queried and updated with JSON-RPC. It should not matter whether you use xbmc mysql or xbmc local database.<br /> <br /> == Limitations == <br /> <br /> The watched-status is only stored based on imdb/thetvdb number. Different Versions of a movie (DVD, BlueRay, Extended Edition, Directors Cut) are all considered equally watched.<br /> <br /> == Alternatives ==<br /> <br /> * Online List of watched movies<br /> ::* http://code.google.com/p/xbmc-follwit/ (Last update April 2012, probably not Frodo-compatible) <br /> ::* ...<br /> * separate script to scan xbmc library (probably not executable from within xbmc)<br /> ::* http://forum.xbmc.org/showthread.php?tid=62874&amp;pid=1280902#pid1280902 <br /> * other similar addons<br /> ::* http://code.google.com/p/xbmc-watched-data/ (defect in Frodo?)<br /> ::* http://forum.xbmc.org/showthread.php?tid=129448&amp;pid=1401643#pid1401643 (working in Frodo, a little bug, because comparison of names instead of unique numbers) <br /> * Export watched flag in nfo file and Import it back again:<br /> ::* http://wiki.xbmc.org/index.php?title=Advancedsettings.xml#.3Cvideolibrary.3E <br /> <br /> == Feedback and Discussion ==<br /> <br /> In case of errors or questions, please post them [http://forum.kodi.tv/showthread.php?tid=164652 in the forum thread].<br /> <br /> [[Category:Helix add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=84613 2015-01-31T17:41:22Z

<p>Schapplm: added sections on limitations and alternatives</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.0.3<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched Movies and TV Episodes independent from filenames<br /> |Description=<br /> Export: Searches the XBMC-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in xbmc.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=<br /> |Forum=<br /> |Website=<br /> |Source=<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/helix/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Debug mode: Show more notifications, create more entries in kodi.log <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with XBMC after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the watchedlist database every time the user changes a watched state <br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible in this time.<br /> <br /> [[File:service_watchedlist_doc_settings_basic.jpg|500px|Basic Settings]]<br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. I recommend a mysql database, since there were problems with the SQLite database file consistency since XBMC v13. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in xbmc or edit this value manually in the &quot;%appdata%\XBMC\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. On the contrary the directory will be filled with new files on every change to the WL-DB (no file Rotation, drive space). <br /> # MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user.<br /> <br /> <br /> [[File:service_watchedlist_doc_settings_database.jpg|500px|Basic Settings]]<br /> <br /> === Useage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> * After Startup, the databases are searched for watched-information (Notification 1).<br /> * Then newly watched movies and tv episodes are written to the addon database (Notification 2). <br /> * After that, media that is not watched in the Kodi database and was previously marked as watched by the addon is again marked as watched in Kodi ( Notifications 3 and 4).<br /> <br /> &lt;gallery&gt;<br /> File:service_watchedlist_doc_notification_start.png|Notification 1<br /> File:service_watchedlist_doc_notification_remember.png|Notification 2<br /> File:service_watchedlist_doc_notification_setwatched_episode.png|Notification 3<br /> File:service_watchedlist_doc_notification_setwatched_movie.png|CNotification 4<br /> &lt;/gallery&gt;<br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> <br /> [[File:service_watchedlist_doc_mysql_watched_movies.jpg|500px|phpmyAdmin View of WatchedList database]]<br /> <br /> For the description of the tables read below.<br /> <br /> ==== SQLite Database file ==== <br /> <br /> The SQLite Database file option is no longer recommended. To transfer an existing SQLite WatchedList? Database, read below.<br /> <br /> The script creates a SQLite database. To view the database I used SQLite Database Browser. <br /> <br /> https://sourceforge.net/projects/sqlitebrowser/files/latest/download<br /> <br /> This figure shows the SQLite db file with automatically created backup copies.<br /> <br /> [[File:service_watchedlist_doc_db_folder.png|500px|File overview]]<br /> <br /> The database has three tables. <br /> <br /> [[File:service_watchedlist_doc_sqlite_structure.png|500px|Database overview]]<br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_movies.png|500px|Movie table overview]]<br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in XBMC, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability.<br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_episode.png|500px|Episode table overview]]<br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, the possibility to use a mysql database was added. This has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database from SQLite db file to mysql:<br /> <br /> * open the old database file in SQLite database browser<br /> * File -&gt; Export -&gt; Database to sql file<br /> * bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO movie_watched VALUES\((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO movie_watched VALUES\((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO episode_watched VALUES\((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO episode_watched VALUES\((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> * Save this new sql file<br /> * execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled. <br /> <br /> == Technical Details ==<br /> <br /> The XBMC Database is queried and updated with JSON-RPC. It should not matter whether you use xbmc mysql or xbmc local database.<br /> <br /> == Limitations == <br /> <br /> The watched-status is only stored based on imdb/thetvdb number. Different Versions of a movie (DVD, BlueRay, Extended Edition, Directors Cut) are all considered equally watched.<br /> <br /> == Alternatives ==<br /> <br /> * Online List of watched movies<br /> ::* http://code.google.com/p/xbmc-follwit/ (Last update April 2012, probably not Frodo-compatible) <br /> ::* ...<br /> * separate script to scan xbmc library (probably not executable from within xbmc)<br /> ::* http://forum.xbmc.org/showthread.php?tid=62874&amp;pid=1280902#pid1280902 <br /> * other similar addons<br /> ::* http://code.google.com/p/xbmc-watched-data/ (defect in Frodo?)<br /> ::* http://forum.xbmc.org/showthread.php?tid=129448&amp;pid=1401643#pid1401643 (working in Frodo, a little bug, because comparison of names instead of unique numbers) <br /> * Export watched flag in nfo file and Import it back again:<br /> ::* http://wiki.xbmc.org/index.php?title=Advancedsettings.xml#.3Cvideolibrary.3E <br /> <br /> [[Category:Helix add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=84612 2015-01-31T17:36:23Z

<p>Schapplm: corrected indentation</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.0.3<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched Movies and TV Episodes independent from filenames<br /> |Description=<br /> Export: Searches the XBMC-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in xbmc.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=<br /> |Forum=<br /> |Website=<br /> |Source=<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/helix/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Debug mode: Show more notifications, create more entries in kodi.log <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with XBMC after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the watchedlist database every time the user changes a watched state <br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible in this time.<br /> <br /> [[File:service_watchedlist_doc_settings_basic.jpg|500px|Basic Settings]]<br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. I recommend a mysql database, since there were problems with the SQLite database file consistency since XBMC v13. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in xbmc or edit this value manually in the &quot;%appdata%\XBMC\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. On the contrary the directory will be filled with new files on every change to the WL-DB (no file Rotation, drive space). <br /> # MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user.<br /> <br /> <br /> [[File:service_watchedlist_doc_settings_database.jpg|500px|Basic Settings]]<br /> <br /> === Useage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> * After Startup, the databases are searched for watched-information (Notification 1).<br /> * Then newly watched movies and tv episodes are written to the addon database (Notification 2). <br /> * After that, media that is not watched in the Kodi database and was previously marked as watched by the addon is again marked as watched in Kodi ( Notifications 3 and 4).<br /> <br /> &lt;gallery&gt;<br /> File:service_watchedlist_doc_notification_start.png|Notification 1<br /> File:service_watchedlist_doc_notification_remember.png|Notification 2<br /> File:service_watchedlist_doc_notification_setwatched_episode.png|Notification 3<br /> File:service_watchedlist_doc_notification_setwatched_movie.png|CNotification 4<br /> &lt;/gallery&gt;<br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> <br /> [[File:service_watchedlist_doc_mysql_watched_movies.jpg|500px|phpmyAdmin View of WatchedList database]]<br /> <br /> For the description of the tables read below.<br /> <br /> ==== SQLite Database file ==== <br /> <br /> The SQLite Database file option is no longer recommended. To transfer an existing SQLite WatchedList? Database, read below.<br /> <br /> The script creates a SQLite database. To view the database I used SQLite Database Browser. <br /> <br /> https://sourceforge.net/projects/sqlitebrowser/files/latest/download<br /> <br /> This figure shows the SQLite db file with automatically created backup copies.<br /> <br /> [[File:service_watchedlist_doc_db_folder.png|500px|File overview]]<br /> <br /> The database has three tables. <br /> <br /> [[File:service_watchedlist_doc_sqlite_structure.png|500px|Database overview]]<br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_movies.png|500px|Movie table overview]]<br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in XBMC, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability.<br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_episode.png|500px|Episode table overview]]<br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, the possibility to use a mysql database was added. This has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database from SQLite db file to mysql:<br /> <br /> # open the old database file in SQLite database browser<br /> # File -&gt; Export -&gt; Database to sql file<br /> # bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO movie_watched VALUES\((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO movie_watched VALUES\((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> ::* Replace regular expression &lt;code&gt;&quot;INSERT INTO episode_watched VALUES\((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO episode_watched VALUES\((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> # Save this new sql file<br /> # execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled. <br /> <br /> [[Category:Helix add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=84611 2015-01-31T17:32:52Z

<p>Schapplm: added images</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.0.3<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched Movies and TV Episodes independent from filenames<br /> |Description=<br /> Export: Searches the XBMC-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in xbmc.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=<br /> |Forum=<br /> |Website=<br /> |Source=<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/helix/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Debug mode: Show more notifications, create more entries in kodi.log <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with XBMC after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the watchedlist database every time the user changes a watched state <br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible in this time.<br /> <br /> [[File:service_watchedlist_doc_settings_basic.jpg|500px|Basic Settings]]<br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. I recommend a mysql database, since there were problems with the SQLite database file consistency since XBMC v13. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in xbmc or edit this value manually in the &quot;%appdata%\XBMC\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. On the contrary the directory will be filled with new files on every change to the WL-DB (no file Rotation, drive space). <br /> # MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user.<br /> <br /> <br /> [[File:service_watchedlist_doc_settings_database.jpg|500px|Basic Settings]]<br /> <br /> === Useage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> * After Startup, the databases are searched for watched-information (Notification 1).<br /> * Then newly watched movies and tv episodes are written to the addon database (Notification 2). <br /> * After that, media that is not watched in the Kodi database and was previously marked as watched by the addon is again marked as watched in Kodi ( Notifications 3 and 4).<br /> <br /> &lt;gallery&gt;<br /> File:service_watchedlist_doc_notification_start.png|Notification 1<br /> File:service_watchedlist_doc_notification_remember.png|Notification 2<br /> File:service_watchedlist_doc_notification_setwatched_episode.png|Notification 3<br /> File:service_watchedlist_doc_notification_setwatched_movie.png|CNotification 4<br /> &lt;/gallery&gt;<br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> <br /> [[File:service_watchedlist_doc_mysql_watched_movies.jpg|500px|phpmyAdmin View of WatchedList database]]<br /> <br /> For the description of the tables read below.<br /> <br /> ==== SQLite Database file ==== <br /> <br /> The SQLite Database file option is no longer recommended. To transfer an existing SQLite WatchedList? Database, read below.<br /> <br /> The script creates a SQLite database. To view the database I used SQLite Database Browser. <br /> <br /> https://sourceforge.net/projects/sqlitebrowser/files/latest/download<br /> <br /> This figure shows the SQLite db file with automatically created backup copies.<br /> <br /> [[File:service_watchedlist_doc_db_folder.png|500px|File overview]]<br /> <br /> The database has three tables. <br /> <br /> [[File:service_watchedlist_doc_sqlite_structure.png|500px|Database overview]]<br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_movies.png|500px|Movie table overview]]<br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in XBMC, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability.<br /> <br /> [[File:service_watchedlist_doc_sqlite_watched_episode.png|500px|Episode table overview]]<br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, I added the possibility to use a mysql database, which has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database:<br /> <br /> # open the old database file in SQLite database browser<br /> # File -&gt; Export -&gt; Database to sql file<br /> # bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> # Replace regular expression &lt;code&gt;&quot;INSERT INTO movie_watched VALUES\((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO movie_watched VALUES\((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> # Replace regular expression &lt;code&gt;&quot;INSERT INTO episode_watched VALUES\((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO episode_watched VALUES\((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> # Save this new sql file<br /> # execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled. <br /> <br /> [[Category:Helix add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=84610 2015-01-31T17:28:21Z

<p>Schapplm: added image</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.0.3<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched Movies and TV Episodes independent from filenames<br /> |Description=<br /> Export: Searches the XBMC-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in xbmc.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=<br /> |Forum=<br /> |Website=<br /> |Source=<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/helix/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Debug mode: Show more notifications, create more entries in kodi.log <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with XBMC after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the watchedlist database every time the user changes a watched state <br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible in this time.<br /> <br /> [[File:service_watchedlist_doc_settings_basic.jpg|500px|Basic Settings]]<br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. I recommend a mysql database, since there were problems with the SQLite database file consistency since XBMC v13. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in xbmc or edit this value manually in the &quot;%appdata%\XBMC\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. On the contrary the directory will be filled with new files on every change to the WL-DB (no file Rotation, drive space). <br /> # MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user.<br /> <br /> <br /> [[File:service_watchedlist_doc_settings_database.jpg|500px|Basic Settings]]<br /> <br /> === Useage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> * After Startup, the databases are searched for watched-information (Notification 1).<br /> * Then newly watched movies and tv episodes are written to the addon database (Notification 2). <br /> * After that, media that is not watched in the Kodi database and was previously marked as watched by the addon is again marked as watched in Kodi ( Notifications 3 and 4).<br /> <br /> &lt;gallery&gt;<br /> File:service_watchedlist_doc_notification_start.png|Notification 1<br /> File:service_watchedlist_doc_notification_remember.png|Notification 2<br /> File:service_watchedlist_doc_notification_setwatched_episode.png|Notification 3<br /> File:service_watchedlist_doc_notification_setwatched_movie.png|CNotification 4<br /> &lt;/gallery&gt;<br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> <br /> [[File:service_watchedlist_doc_mysql_watched_movies.jpg|500px|phpmyAdmin View of WatchedList database]]<br /> <br /> For the description of the tables read below.<br /> <br /> ==== SQLite Database file ==== <br /> <br /> The SQLite Database file option is no longer recommended. To transfer an existing SQLite WatchedList? Database, read below.<br /> <br /> The script creates a SQLite database. To view the database I used SQLite Database Browser. <br /> <br /> https://sourceforge.net/projects/sqlitebrowser/files/latest/download<br /> <br /> This figure shows the SQLite db file with automatically created backup copies.<br /> <br /> The database has three tables. <br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in XBMC, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability. <br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, I added the possibility to use a mysql database, which has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database:<br /> <br /> # open the old database file in SQLite database browser<br /> # File -&gt; Export -&gt; Database to sql file<br /> # bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> # Replace regular expression &lt;code&gt;&quot;INSERT INTO movie_watched VALUES\((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO movie_watched VALUES\((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> # Replace regular expression &lt;code&gt;&quot;INSERT INTO episode_watched VALUES\((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO episode_watched VALUES\((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> # Save this new sql file<br /> # execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled. <br /> <br /> [[Category:Helix add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=84609 2015-01-31T17:26:33Z

<p>Schapplm: added images</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.0.3<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched Movies and TV Episodes independent from filenames<br /> |Description=<br /> Export: Searches the XBMC-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in xbmc.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=<br /> |Forum=<br /> |Website=<br /> |Source=<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/helix/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Debug mode: Show more notifications, create more entries in kodi.log <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with XBMC after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the watchedlist database every time the user changes a watched state <br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible in this time.<br /> <br /> [[File:service_watchedlist_doc_settings_basic.jpg|500px|Basic Settings]]<br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. I recommend a mysql database, since there were problems with the SQLite database file consistency since XBMC v13. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in xbmc or edit this value manually in the &quot;%appdata%\XBMC\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. On the contrary the directory will be filled with new files on every change to the WL-DB (no file Rotation, drive space). <br /> # MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user.<br /> <br /> <br /> [[File:service_watchedlist_doc_settings_database.jpg|500px|Basic Settings]]<br /> <br /> === Useage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> * After Startup, the databases are searched for watched-information (Notification 1).<br /> * Then newly watched movies and tv episodes are written to the addon database (Notification 2). <br /> * After that, media that is not watched in the Kodi database and was previously marked as watched by the addon is again marked as watched in Kodi ( Notifications 3 and 4).<br /> <br /> &lt;gallery&gt;<br /> File:service_watchedlist_doc_notification_start.png|Notification 1<br /> File:service_watchedlist_doc_notification_remember.png|Notification 2<br /> File:service_watchedlist_doc_notification_setwatched_episode.png|Notification 3<br /> File:service_watchedlist_doc_notification_setwatched_movie.png|CNotification 4<br /> &lt;/gallery&gt;<br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> For the description of the tables read below. <br /> <br /> ==== SQLite Database file ==== <br /> <br /> The SQLite Database file option is no longer recommended. To transfer an existing SQLite WatchedList? Database, read below.<br /> <br /> The script creates a SQLite database. To view the database I used SQLite Database Browser. <br /> <br /> https://sourceforge.net/projects/sqlitebrowser/files/latest/download<br /> <br /> This figure shows the SQLite db file with automatically created backup copies.<br /> <br /> The database has three tables. <br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in XBMC, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability. <br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, I added the possibility to use a mysql database, which has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database:<br /> <br /> # open the old database file in SQLite database browser<br /> # File -&gt; Export -&gt; Database to sql file<br /> # bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> # Replace regular expression &lt;code&gt;&quot;INSERT INTO movie_watched VALUES\((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO movie_watched VALUES\((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> # Replace regular expression &lt;code&gt;&quot;INSERT INTO episode_watched VALUES\((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO episode_watched VALUES\((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> # Save this new sql file<br /> # execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled. <br /> <br /> [[Category:Helix add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=84608 2015-01-31T17:20:31Z

<p>Schapplm: added image</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.0.3<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched Movies and TV Episodes independent from filenames<br /> |Description=<br /> Export: Searches the XBMC-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in xbmc.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=<br /> |Forum=<br /> |Website=<br /> |Source=<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/helix/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Debug mode: Show more notifications, create more entries in kodi.log <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with XBMC after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the watchedlist database every time the user changes a watched state <br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible in this time.<br /> <br /> [[File:service_watchedlist_doc_settings_basic.jpg|500px|Basic Settings]]<br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. I recommend a mysql database, since there were problems with the SQLite database file consistency since XBMC v13. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in xbmc or edit this value manually in the &quot;%appdata%\XBMC\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. On the contrary the directory will be filled with new files on every change to the WL-DB (no file Rotation, drive space). <br /> # MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user.<br /> <br /> <br /> [[File:service_watchedlist_doc_settings_database.jpg|500px|Basic Settings]]<br /> <br /> === Useage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> After Startup, the databases are searched for watched-information. <br /> Then newly watched movies and tv episodes are written to the addon database (Remember): <br /> After that, media that is not watched in the XBMC database and was previously marked as watched by the addon is again marked as watched in XBMC. <br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> For the description of the tables read below. <br /> <br /> ==== SQLite Database file ==== <br /> <br /> The SQLite Database file option is no longer recommended. To transfer an existing SQLite WatchedList? Database, read below.<br /> <br /> The script creates a SQLite database. To view the database I used SQLite Database Browser. <br /> <br /> https://sourceforge.net/projects/sqlitebrowser/files/latest/download<br /> <br /> This figure shows the SQLite db file with automatically created backup copies.<br /> <br /> The database has three tables. <br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in XBMC, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability. <br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, I added the possibility to use a mysql database, which has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database:<br /> <br /> # open the old database file in SQLite database browser<br /> # File -&gt; Export -&gt; Database to sql file<br /> # bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> # Replace regular expression &lt;code&gt;&quot;INSERT INTO movie_watched VALUES\((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO movie_watched VALUES\((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> # Replace regular expression &lt;code&gt;&quot;INSERT INTO episode_watched VALUES\((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO episode_watched VALUES\((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> # Save this new sql file<br /> # execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled. <br /> <br /> [[Category:Helix add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=84607 2015-01-31T17:19:43Z

<p>Schapplm: added image</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.0.3<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched Movies and TV Episodes independent from filenames<br /> |Description=<br /> Export: Searches the XBMC-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in xbmc.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=<br /> |Forum=<br /> |Website=<br /> |Source=<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/helix/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Debug mode: Show more notifications, create more entries in kodi.log <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with XBMC after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the watchedlist database every time the user changes a watched state <br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible in this time.<br /> <br /> [[File:service_watchedlist_doc_settings_basic.jpg|500px|Basic Settings]]<br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. I recommend a mysql database, since there were problems with the SQLite database file consistency since XBMC v13. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in xbmc or edit this value manually in the &quot;%appdata%\XBMC\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. On the contrary the directory will be filled with new files on every change to the WL-DB (no file Rotation, drive space). <br /> # MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user. <br /> <br /> === Useage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> After Startup, the databases are searched for watched-information. <br /> Then newly watched movies and tv episodes are written to the addon database (Remember): <br /> After that, media that is not watched in the XBMC database and was previously marked as watched by the addon is again marked as watched in XBMC. <br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> For the description of the tables read below. <br /> <br /> ==== SQLite Database file ==== <br /> <br /> The SQLite Database file option is no longer recommended. To transfer an existing SQLite WatchedList? Database, read below.<br /> <br /> The script creates a SQLite database. To view the database I used SQLite Database Browser. <br /> <br /> https://sourceforge.net/projects/sqlitebrowser/files/latest/download<br /> <br /> This figure shows the SQLite db file with automatically created backup copies.<br /> <br /> The database has three tables. <br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in XBMC, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability. <br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, I added the possibility to use a mysql database, which has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database:<br /> <br /> # open the old database file in SQLite database browser<br /> # File -&gt; Export -&gt; Database to sql file<br /> # bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> # Replace regular expression &lt;code&gt;&quot;INSERT INTO movie_watched VALUES\((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO movie_watched VALUES\((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> # Replace regular expression &lt;code&gt;&quot;INSERT INTO episode_watched VALUES\((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO episode_watched VALUES\((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> # Save this new sql file<br /> # execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled. <br /> <br /> [[Category:Helix add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=File:Service_watchedlist_doc_superrepo.jpg&diff=84603 2015-01-31T17:14:54Z

<p>Schapplm: MsUpload</p> <hr /> <div>MsUpload</div>

Schapplm https://kodi.wiki/index.php?title=File:Service_watchedlist_doc_sqlite_watched_movies.png&diff=84602 2015-01-31T17:14:53Z

<p>Schapplm: MsUpload</p> <hr /> <div>MsUpload</div>

Schapplm https://kodi.wiki/index.php?title=File:Service_watchedlist_doc_sqlite_watched_episode.png&diff=84601 2015-01-31T17:14:52Z

<p>Schapplm: MsUpload</p> <hr /> <div>MsUpload</div>

Schapplm https://kodi.wiki/index.php?title=File:Service_watchedlist_doc_sqlite_structure.png&diff=84600 2015-01-31T17:14:51Z

<p>Schapplm: MsUpload</p> <hr /> <div>MsUpload</div>

Schapplm https://kodi.wiki/index.php?title=File:Service_watchedlist_doc_settings_database.jpg&diff=84599 2015-01-31T17:14:51Z

<p>Schapplm: MsUpload</p> <hr /> <div>MsUpload</div>

Schapplm https://kodi.wiki/index.php?title=File:Service_watchedlist_doc_settings_basic.jpg&diff=84598 2015-01-31T17:14:49Z

<p>Schapplm: MsUpload</p> <hr /> <div>MsUpload</div>

Schapplm https://kodi.wiki/index.php?title=File:Service_watchedlist_doc_notification_start.png&diff=84597 2015-01-31T17:14:48Z

<p>Schapplm: MsUpload</p> <hr /> <div>MsUpload</div>

Schapplm https://kodi.wiki/index.php?title=File:Service_watchedlist_doc_notification_setwatched_movie.png&diff=84596 2015-01-31T17:14:47Z

<p>Schapplm: MsUpload</p> <hr /> <div>MsUpload</div>

Schapplm https://kodi.wiki/index.php?title=File:Service_watchedlist_doc_notification_setwatched_episode.png&diff=84595 2015-01-31T17:14:47Z

<p>Schapplm: MsUpload</p> <hr /> <div>MsUpload</div>

Schapplm https://kodi.wiki/index.php?title=File:Service_watchedlist_doc_notification_remember.png&diff=84594 2015-01-31T17:14:46Z

<p>Schapplm: MsUpload</p> <hr /> <div>MsUpload</div>

Schapplm https://kodi.wiki/index.php?title=File:Service_watchedlist_doc_mysql_watched_movies.jpg&diff=84593 2015-01-31T17:14:45Z

<p>Schapplm: MsUpload</p> <hr /> <div>MsUpload</div>

Schapplm https://kodi.wiki/index.php?title=File:Service_watchedlist_doc_db_folder.png&diff=84592 2015-01-31T17:14:44Z

<p>Schapplm: MsUpload</p> <hr /> <div>MsUpload</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:WatchedList&diff=84590 2015-01-31T17:12:07Z

<p>Schapplm: Added Setup and Useage Instructions (without images)</p> <hr /> <div>{{Addon <br /> |Name=WatchedList<br /> |provider-name=schapplm<br /> |ID=service.watchedlist<br /> |latest-version=1.0.3<br /> |extension point=xbmc.python.script<br /> |provides=executable<br /> |Summary=Save watched Movies and TV Episodes independent from filenames<br /> |Description=<br /> Export: Searches the XBMC-Database for watched files. Determine imdb-id and thetvdb-id to identify movies and TV-episodes. Then save the list to a new independent table.<br /> Import: Set the watched state for each video file in xbmc.<br /> Automatic background process without user interaction.<br /> |Platform=all<br /> |Language=<br /> |License=<br /> |Forum=<br /> |Website=<br /> |Source=<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.kodi.tv/addons/helix/service.watchedlist/icon.png}}<br /> <br /> == Setup ==<br /> <br /> === Basic Settings ===<br /> <br /> # Debug mode: Show more notifications, create more entries in kodi.log <br /> # Update watched state of movies <br /> # Update watched state of episodes <br /> # Autorun: starts with XBMC after a delay time of ''x'' minutes. <br /> # Startup delay (see above ''x''). Set the delay time to not disturb directly at startup. <br /> # Autostart mode: 'one update' only does one full update of the watchedlist and then quits. 'periodic' executes this update in the interval given below. 'no update' does no full update. You have the possibility to run WatchedList in background. <br /> # Update interval (active if set to 'periodic' above)<br /> # Follow user ...: Run in background and update the watchedlist database every time the user changes a watched state <br /> # Progress dialog: Show a progress bar for every full update. No user interaction possible in this time. <br /> <br /> <br /> === Database Settings ===<br /> <br /> # DB Method: Either use a SQLite db file or a mysql server for the database of this addon. I recommend a mysql database, since there were problems with the SQLite database file consistency since XBMC v13. The default setting is a local SQLite db file. This is suitable for backup of the local watched states in case of file movements or Kodi database cleaning.<br /> # DB File: Use a non-default database file (not in [...]/userdata/addon_data/service.watchedlist) <br /> # DB File: Path to the database-file. To add a network path for access from multiple clients you can browse the path in xbmc or edit this value manually in the &quot;%appdata%\XBMC\userdata\addon_data\service.watchedlist\settings.xml&quot;. <br /> # DB File: Filename of the database (SQLite .db file) <br /> # DB File: Create a zip backup copy (ca. 40 KB) of the database (ca 100 KB) each time before writing it. With this you can restore any state you want, e.g. when you mess with your kodi-database and too much media is marked as watched. On the contrary the directory will be filled with new files on every change to the WL-DB (no file Rotation, drive space). <br /> # MySQL: IP-adress of the Server. Make sure, there is a mysql server running. To start, use [MySQL/Setting_up_MySQL this] guide. <br /> # MySQL: 3306 is the default mysql port. No need to change it. <br /> # MySQL: Name of the database. You manually need to create this database on the mysql server (use phpMyAdmin) <br /> # MySQL: Username. This user must exist and have all necessary permissions on the database set before <br /> # MySQL: password for this user. <br /> <br /> === Useage ===<br /> <br /> This addon runs in the background as a service. There is no interaction with the user. The script only gives messages about the current operation<br /> <br /> After Startup, the databases are searched for watched-information. <br /> Then newly watched movies and tv episodes are written to the addon database (Remember): <br /> After that, media that is not watched in the XBMC database and was previously marked as watched by the addon is again marked as watched in XBMC. <br /> <br /> === Database ===<br /> <br /> ==== MySQL Database ====<br /> <br /> The mySQL database stores all relevant information. It looks like this:<br /> For the description of the tables read below. <br /> <br /> ==== SQLite Database file ==== <br /> <br /> The SQLite Database file option is no longer recommended. To transfer an existing SQLite WatchedList? Database, read below.<br /> <br /> The script creates a SQLite database. To view the database I used SQLite Database Browser. <br /> <br /> https://sourceforge.net/projects/sqlitebrowser/files/latest/download<br /> <br /> This figure shows the SQLite db file with automatically created backup copies.<br /> <br /> The database has three tables. <br /> <br /> The first table stores the watched movies by imdb-number. The title column is only for easier user access to the table. <br /> <br /> The second table stores watched tv episodes with unique number for the TV Show (this field is called imdbnumber in XBMC, but this is the TheTVDB number). The names of the tv shows are stored in a third table, only for better readability. <br /> <br /> ==== Conversion from SQLite database to mysql database ====<br /> <br /> In Version 1.0.0 of this addon, I added the possibility to use a mysql database, which has a few advantages over the SQLite Database file: <br /> <br /> * simultaneous access possible <br /> * mysql handles all the database access, therefore no permanent backup copying necessary <br /> * no filesystem access in the addon. Should lead to fewer errors <br /> <br /> How to convert the database:<br /> <br /> # open the old database file in SQLite database browser<br /> # File -&gt; Export -&gt; Database to sql file<br /> # bring this into the new format. For Replacement, I used Notepad++ in Windows:<br /> # Replace regular expression &lt;code&gt;&quot;INSERT INTO movie_watched VALUES\((\d+),(\d+),(\d+),(\d+),&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO movie_watched VALUES\((\1),(\2),FROM_UNIXTIME\((\3)\),FROM_UNIXTIME\((\4)\),&quot;&lt;/code&gt;<br /> # Replace regular expression &lt;code&gt;&quot;INSERT INTO episode_watched VALUES\((\d+),(\d+),(\d+),(\d+),(\d+),(\d+)\)&quot;&lt;/code&gt; with &lt;code&gt;&quot;INSERT IGNORE INTO episode_watched VALUES\((\1),(\2),(\3),(\4),FROM_UNIXTIME\((\5)\),FROM_UNIXTIME\((\6)\)\)&quot;&lt;/code&gt;<br /> # Save this new sql file<br /> # execute the commands in the &quot;INSERT&quot;-commands in the sql query interface in phpmyadmin after the tables were generated at the first start of the watchedlist addon with mysql option enabled. <br /> <br /> [[Category:Helix add-on repository]]</div>

Schapplm https://kodi.wiki/index.php?title=Archive:Debug_Python_Scripts_with_Eclipse&diff=83939 2015-01-11T15:31:29Z

<p>Schapplm: /* Add to your python script the code for remote debug */</p> <hr /> <div>{{mininav|[[Development]]|[[Add-on development]]|[[Python development]]}}<br /> <br /> Here is a method you can adopt in order to use the Eclipse (multi-platforms) remote debugger with your Python scripts/plugin.<br /> <br /> Note: Follow this link [[HOW-TO debug Python Scripts|Debugging Python Scripts on Linux with WinPDB]] for more information if you prefer to use WinPDB instead.<br /> <br /> Note: The information provided herein is also applicable to user with [http://www.aptana.com/ Aptana Studio 3] installation which come pre-installed with pydev. For this case, you can skip to [[#Configure Pydev and Eclipse|Configure Pydev and Eclipse]] after the Aptana Studio 3 installation.<br /> <br /> <br /> <br /> == Prerequisite ==<br /> * Any platform able to run [http://www.eclipse.org/downloads/ Eclipse IDE] (Windows 32bit-64bit, Mac Carbon 32bit-64bit, Mac Cocoa 32bit-64bit, Linux 32bit-64bit): it is the platform from where you will run the debugger IDE<br /> * Python interpreter 2.4 (use the same version as XBMC or version &lt;= 2.7 ) install on the machine running Eclipse<br /> * Any platform running XBMC (Xbox, Linux, MACOSX, Windows): it is the platform running Python scripts/plugin connecting with the remote debugger.<br /> :XBMC installed on Ubuntu (should work just fine on Windows and Mac too)<br /> * [http://pydev.org/ Pydev] plugin for Eclipse IDE: Pydev is a Python IDE for Eclipse, which may be used in Python, Jython and IronPython development.<br /> <br /> == Prepare and Setup Eclipse ==<br /> <br /> === Install Eclipse ===<br /> * Download [http://www.eclipse.org/downloads/ Eclipse IDE] and install it<br /> Note: in our example Eclipse Galileo (3.5.1) is used<br /> <br /> <br /> <br /> === Install Pydev in Eclipse ===<br /> * In Eclipse go in: ''Help'' -&gt; ''Install New Software...''<br /> * Click on the ''Add'' button and add Pydev website as a source: http://pydev.org/updates<br /> * You will see the window below:<br /> [[File:EclipsePydevUpdate.png]]<br /> * Check ''PyDev'' box and follow the steps in order to install PyDev<br /> Note: in our example PyDev 1.5.5<br /> <br /> <br /> <br /> === Configure Pydev and Eclipse ===<br /> <br /> <br /> ==== Add Python Interpreter Path ====<br /> * Go in ''Window'' -&gt; ''Preferences''<br /> * ''Pydev'' then ''Interpreter - Python''<br /> * Click on button ''New...''<br /> * In the new prompt, enter the ''Interpreter Name: Python'', and Browse for your Python Interpreter 2.4 ''python.exe'' file and select it. After that you should see something like this:<br /> [[File:EclipsePydevPref.png|none]]<br /> This will help in order to have Python code completion (except for XBMC modules)<br /> <br /> ==== Add Pydev view to Eclipse ====<br /> * On the top right corner click on the View button on select ''Others''<br /> [[File:EclipsePydevViewMenu.png]]<br /> * Select Pydev then OK, a PyDev View Button should be now available on the top right corner<br /> [[File:EclipsePydevViewMenu2.png]]<br /> Use this view for your developments in Python for XBMC<br /> <br /> <br /> ==== Add Pydev Start/Stop debug server buttons ====<br /> * In the menu bar select ''Window'' -&gt; ''Customize perspective...'', a window ''Customize Perspective - PyDev'' will open<br /> * Select ''Command Groups Availability'' Tab<br /> * Check ''Pydev Debug'' box and OK<br /> * You should see 2 new buttons in your toolbar:<br /> [[File:EclipsePydevDebugSrvButtons.png]]<br /> <br /> <br /> ==== Setting the remote debugger port (optional) ====<br /> If you do not want to use the default port (usually 5678) you can set it up:<br /> * Go to ''Window'' -&gt; ''Preferences''<br /> * ''Pydev'' then ''Debug'' you can define here the port and the timeout you want<br /> <br /> ==== Setting up Predefined Completions (optional) ====<br /> Many developers are accustom to using predefined completions when writing their code (eg. type-ahead). The standard Python completions are enabled by default when using these instructions, but the standard XBMC components will not be recognized appropriately (xbmc, xbmcgui, xbmcplugin, etc). <br /> <br /> In order to overcome this, you can run the [http://forum.xbmc.org/showthread.php?t=79070 PyDev Predefined Completions Creator addon] and [http://pydev.org/manual_101_interpreter.html#PyDevInterpreterConfiguration-PredefinedCompletions setup Eclipse] to reference this file:<br /> # Download the 'PyDev Predefined Completions Creator' Addon (eg. System &gt; Settings &gt; Addons &gt; XBMC.org &gt; Program Add-Ons)<br /> # Navigate to the newly installed Addon (eg. Programs from the home screen)<br /> # Open the context menu for newly installed addon and select 'Add-on Settings'<br /> # Set the location to save the help docs to and save the new settings (This can be anywhere on your system - we'll configure it in Eclipse later)<br /> # Select the add-on to run it (the addon should run and close quickly)<br /> # Open Eclipse and select Window &gt; Preferences &gt; PyDev &gt; Interpreter - Python<br /> # From the 'Predefined' tab, click the new button and select the folder you created in the step above<br /> # Press Apply / OK to ensure the changes are saved<br /> <br /> == Create a Python script/plugin for XBMC in Eclipse ==<br /> <br /> <br /> === Create a new PyDev Project ===<br /> Most of the time when you are doing development, likely that you are running XBMC and Eclipse on the same platform; (The installed debugger described in this article actually can also work with a remote XBMC).&lt;br\&gt;<br /> Let's say you already have scripts installed in XBMC script folder that you want to create a new PyDev project e.g.<br /> &lt;pre&gt;<br /> C:\XBMC\addons\myscript1<br /> C:\XBMC\addons\myscript2<br /> &lt;/pre&gt;<br /> <br /> With myscript1 &amp; myscript2 being sub-directories of ''C:\XBMC\addons'' each containing the Default.py scripts.&lt;br\&gt;<br /> First you need to define the Python project workspace:<br /> * ''File'' -&gt; ''Switch Workspace'' -&gt; ''Other...''<br /> * ''Browse'' to the parent directory of your script module i.e. ''C:\XBMC\addons'' in this example, select and OK<br /> Then proceed to create the Python project:<br /> * ''File'' -&gt; ''New'' -&gt; ''PyDev Project''<br /> : OR select below in case ''PyDev Project'' is not displayed<br /> * ''File'' -&gt; ''New'' -&gt; ''Others''; and Select ''Pydev'' then ''PyDev Project''; Click ''Next''<br /> * Enter the name of your project e.g. xbmc_addons<br /> * Uncheck option ''Use Default''<br /> * Browse to the directory of your scripts and select i.e. C:\XBMC\addons.<br /> * Set ''Python' as Project Type<br /> * Select ''2.4 (XBMC Python version)'' for the grammar<br /> * Select ''Don't configure PYTHONPATH (to be done manually later on)''<br /> * Click on ''Finish'' button<br /> <br /> <br /> === Set the Python Path ===<br /> * Right click on your new project and select ''Properties''<br /> * Select ''PyDev - PYTHONPATH'' and click on ''Add source folder''<br /> * Select the source directory of your script, /xbmc_addons in our example<br /> <br /> <br /> === Import File System ===<br /> Assuming you want to add in all the directories under C:\XBMC\addons<br /> * Right click on your new project and select ''Import...''<br /> * Select ''General'' and click on ''File System''; then ''Next''<br /> * Browse to the source directory of your script (or plugin) e.g. C:\XBMC\addons<br /> * Check the directory and files to be added<br /> * Select ''Into folder: xbmc_addons''<br /> * Select ''Options | &lt;&lt;Advanced | Create links in workspace''<br /> * Uncheck both the options i.e. ''Create virtual folders'' &amp; ''Create link locations relative to;...''<br /> * Click on ''Finish'' button<br /> Your source code is now recognized by Eclipse and you will have access to neat functionality such as code completion, link between source files, etc.<br /> <br /> <br /> === Add Pydev Python source code (pysrc) to XBMC ===<br /> XBMC needs to know where to find the PyDev remote python source file in order to communicate with the remote debugger of Eclipse.<br /> <br /> ==== Identify where PyDev remote debugger Python files are ====<br /> Python source files should be in you Eclipse installation directory:<br /> &lt;pre&gt;C:\...\eclipse\plugins\org.python.pydev.debug_1.5.5.2010030420\pysrc\&lt;/pre&gt;<br /> In our case we use PyDev 1.5.5. With newer versions of PyDev, the directory structure changed.<br /> &lt;pre&gt;C:\...\eclipse\plugins\org.python.pydev_3.6.0.201406232321\pysrc\&lt;/pre&gt;<br /> Look for org.python.pydev.debug (not core)<br /> <br /> Instructions for Linux users:<br /> <br /> {{Collapse top}}<br /> In new Eclipse versions on Linux, the standard eclipse installation (/usr/share/eclipse/plugins) does not contain the pydev files any more.<br /> The easiest solution is to install the [[Add-on:Pydevd|pydevd-addon]].&lt;br /&gt;<br /> To access this from your addon, your addon.xml has to contain &lt;code&gt;&lt;import addon=&quot;script.module.pydevd&quot; version=&quot;3.4.1&quot;/&gt;&lt;/code&gt;.<br /> {{Collapse bottom}}<br /> <br /> ==== Modify PyDev source in order to support XBMC paths ====<br /> The pysrc code that came with Eclipse-pydev does not support XBMC paths (special://... or Q:/...) and the module would not find them making it impossible to insert breakpoints in such files.<br /> <br /> In order to add the support of XBMC paths, you will need to do a simple modification to the file ''pydevd_file_utils.py'' consisting on adding a line to each procedure that had a filename parameter (4 procedures in total). <br /> Add a line like<br /> <br /> <br /> def _NormFile(filename):<br /> filename = xbmc.translatePath(filename)<br /> try:<br /> ...<br /> <br /> The other three procedures are:<br /> * def _NormFile(filename):<br /> * def NormFileToServer(filename):<br /> * def NormFileToClient(filename):<br /> <br /> of course you need the import directive at the top of the file:<br /> <br /> import xbmc<br /> <br /> at the beginning of the module...<br /> <br /> ==== Choose how XBMC will refer to Pydev debugging module ====<br /> <br /> You have 3 options as below:<br /> * Option 1 - Refer from our python script directly the directory where pysrc is installed<br /> * Option 2 - Copy pysrc in our script directory and refer it from our script<br /> * Option 3 - Copy pysrc in XBMC Python install<br /> * Option 4 - Use the pydev from the [[Add-on:Pydevd|pydevd-addon]]<br /> <br /> I am only going to show you the steps for ''Option 3'':<br /> <br /> ==== Copy pysrc in XBMC Python install ====<br /> ===== Option 3: (Suggested for Windows users) =====<br /> * Copy the content of pysrc to:<br /> &lt;pre&gt;XBMC\system\python\Lib\pysrc\&lt;/pre&gt;<br /> * Add an empty __init__.py file in it<br /> <br /> ===== Option 4: (Suggested for Linux users) =====<br /> Use the [[Add-on:Pydevd|pydevd-addon]] as described above. No action necessary. Option 3 does not work on Linux, because /usr/share/kodi/system/python/Lib is ignored.<br /> <br /> === Add to your python script the code for remote debug ===<br /> At the beginning of you Python script/plugin (usually Default.py) add the following code:<br /> &lt;pre&gt;<br /> REMOTE_DBG = True <br /> <br /> # append pydev remote debugger<br /> if REMOTE_DBG:<br /> # Make pydev debugger works for auto reload.<br /> # Note pydevd module need to be copied in XBMC\system\python\Lib\pysrc<br /> try:<br /> import pysrc.pydevd as pydevd # with the addon script.module.pydevd, only use `import pydevd`<br /> # stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console<br /> pydevd.settrace('localhost', stdoutToServer=True, stderrToServer=True)<br /> except ImportError:<br /> sys.stderr.write(&quot;Error: &quot; +<br /> &quot;You must add org.python.pydev.debug.pysrc to your PYTHONPATH.&quot;)<br /> sys.exit(1)<br /> &lt;/pre&gt;<br /> <br /> In the case you have change the default port you can replace the line with pydevd.settrace by this one:<br /> &lt;pre&gt;<br /> pydevd.settrace('localhost', port=5678, stdoutToServer=True, stderrToServer=True)<br /> &lt;/pre&gt;<br /> <br /> * Use REMOTE_DBG in order to activate or not the remote debugging<br /> * port specifies the listening port number use between the client and the server<br /> * Replace localhost by an IP address if XBMC and Eclipse are on 2 different machines<br /> * stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console, you won't have to open xbmc.log file<br /> <br /> === Run ===<br /> * Go in Debug view (Eclipse: [[File:changeperspective.png]] / Debug ) and press on the start server button: [[File:EclipsePydevDebugSrvButtons.png]]<br /> <br /> * You will see in the console logs like:<br /> &lt;pre&gt;Debug Server at port: 5678&lt;/pre&gt;<br /> <br /> * Start XBMC and run your script/plugin, you will see it as &quot;Running&quot; but paused<br /> <br /> * In Eclipse (Debug View) click on the Resume button (or F8), then you will see the program running in XBMC<br /> <br /> * You are now fully set up: You can set break-point, watch on variables, run step by step etc<br /> <br /> * Enjoy!<br /> <br /> === Screenshot ===<br /> <br /> [[File:EclipsePydevDebugger.png]]<br /> <br /> ==See also==<br /> * [[Add-ons]]<br /> * [[:Category:All add-ons]]<br /> * [[3rd party add-on repositories]]<br /> '''Development:'''<br /> * [[Add-on development]]<br /> * [[Addon Settings]]<br /> * [[Python development]]<br /> * [[Add-on repositories]]<br /> * [[Official add-on repository]]<br /> <br /> [[Category:Python]]<br /> [[Category:How-to]]<br /> [[Category:Add-on development]]</div>

Schapplm https://kodi.wiki/index.php?title=Archive:Debug_Python_Scripts_with_Eclipse&diff=83938 2015-01-11T15:29:26Z

<p>Schapplm: /* Copy pysrc in XBMC Python install */</p> <hr /> <div>{{mininav|[[Development]]|[[Add-on development]]|[[Python development]]}}<br /> <br /> Here is a method you can adopt in order to use the Eclipse (multi-platforms) remote debugger with your Python scripts/plugin.<br /> <br /> Note: Follow this link [[HOW-TO debug Python Scripts|Debugging Python Scripts on Linux with WinPDB]] for more information if you prefer to use WinPDB instead.<br /> <br /> Note: The information provided herein is also applicable to user with [http://www.aptana.com/ Aptana Studio 3] installation which come pre-installed with pydev. For this case, you can skip to [[#Configure Pydev and Eclipse|Configure Pydev and Eclipse]] after the Aptana Studio 3 installation.<br /> <br /> <br /> <br /> == Prerequisite ==<br /> * Any platform able to run [http://www.eclipse.org/downloads/ Eclipse IDE] (Windows 32bit-64bit, Mac Carbon 32bit-64bit, Mac Cocoa 32bit-64bit, Linux 32bit-64bit): it is the platform from where you will run the debugger IDE<br /> * Python interpreter 2.4 (use the same version as XBMC or version &lt;= 2.7 ) install on the machine running Eclipse<br /> * Any platform running XBMC (Xbox, Linux, MACOSX, Windows): it is the platform running Python scripts/plugin connecting with the remote debugger.<br /> :XBMC installed on Ubuntu (should work just fine on Windows and Mac too)<br /> * [http://pydev.org/ Pydev] plugin for Eclipse IDE: Pydev is a Python IDE for Eclipse, which may be used in Python, Jython and IronPython development.<br /> <br /> == Prepare and Setup Eclipse ==<br /> <br /> === Install Eclipse ===<br /> * Download [http://www.eclipse.org/downloads/ Eclipse IDE] and install it<br /> Note: in our example Eclipse Galileo (3.5.1) is used<br /> <br /> <br /> <br /> === Install Pydev in Eclipse ===<br /> * In Eclipse go in: ''Help'' -&gt; ''Install New Software...''<br /> * Click on the ''Add'' button and add Pydev website as a source: http://pydev.org/updates<br /> * You will see the window below:<br /> [[File:EclipsePydevUpdate.png]]<br /> * Check ''PyDev'' box and follow the steps in order to install PyDev<br /> Note: in our example PyDev 1.5.5<br /> <br /> <br /> <br /> === Configure Pydev and Eclipse ===<br /> <br /> <br /> ==== Add Python Interpreter Path ====<br /> * Go in ''Window'' -&gt; ''Preferences''<br /> * ''Pydev'' then ''Interpreter - Python''<br /> * Click on button ''New...''<br /> * In the new prompt, enter the ''Interpreter Name: Python'', and Browse for your Python Interpreter 2.4 ''python.exe'' file and select it. After that you should see something like this:<br /> [[File:EclipsePydevPref.png|none]]<br /> This will help in order to have Python code completion (except for XBMC modules)<br /> <br /> ==== Add Pydev view to Eclipse ====<br /> * On the top right corner click on the View button on select ''Others''<br /> [[File:EclipsePydevViewMenu.png]]<br /> * Select Pydev then OK, a PyDev View Button should be now available on the top right corner<br /> [[File:EclipsePydevViewMenu2.png]]<br /> Use this view for your developments in Python for XBMC<br /> <br /> <br /> ==== Add Pydev Start/Stop debug server buttons ====<br /> * In the menu bar select ''Window'' -&gt; ''Customize perspective...'', a window ''Customize Perspective - PyDev'' will open<br /> * Select ''Command Groups Availability'' Tab<br /> * Check ''Pydev Debug'' box and OK<br /> * You should see 2 new buttons in your toolbar:<br /> [[File:EclipsePydevDebugSrvButtons.png]]<br /> <br /> <br /> ==== Setting the remote debugger port (optional) ====<br /> If you do not want to use the default port (usually 5678) you can set it up:<br /> * Go to ''Window'' -&gt; ''Preferences''<br /> * ''Pydev'' then ''Debug'' you can define here the port and the timeout you want<br /> <br /> ==== Setting up Predefined Completions (optional) ====<br /> Many developers are accustom to using predefined completions when writing their code (eg. type-ahead). The standard Python completions are enabled by default when using these instructions, but the standard XBMC components will not be recognized appropriately (xbmc, xbmcgui, xbmcplugin, etc). <br /> <br /> In order to overcome this, you can run the [http://forum.xbmc.org/showthread.php?t=79070 PyDev Predefined Completions Creator addon] and [http://pydev.org/manual_101_interpreter.html#PyDevInterpreterConfiguration-PredefinedCompletions setup Eclipse] to reference this file:<br /> # Download the 'PyDev Predefined Completions Creator' Addon (eg. System &gt; Settings &gt; Addons &gt; XBMC.org &gt; Program Add-Ons)<br /> # Navigate to the newly installed Addon (eg. Programs from the home screen)<br /> # Open the context menu for newly installed addon and select 'Add-on Settings'<br /> # Set the location to save the help docs to and save the new settings (This can be anywhere on your system - we'll configure it in Eclipse later)<br /> # Select the add-on to run it (the addon should run and close quickly)<br /> # Open Eclipse and select Window &gt; Preferences &gt; PyDev &gt; Interpreter - Python<br /> # From the 'Predefined' tab, click the new button and select the folder you created in the step above<br /> # Press Apply / OK to ensure the changes are saved<br /> <br /> == Create a Python script/plugin for XBMC in Eclipse ==<br /> <br /> <br /> === Create a new PyDev Project ===<br /> Most of the time when you are doing development, likely that you are running XBMC and Eclipse on the same platform; (The installed debugger described in this article actually can also work with a remote XBMC).&lt;br\&gt;<br /> Let's say you already have scripts installed in XBMC script folder that you want to create a new PyDev project e.g.<br /> &lt;pre&gt;<br /> C:\XBMC\addons\myscript1<br /> C:\XBMC\addons\myscript2<br /> &lt;/pre&gt;<br /> <br /> With myscript1 &amp; myscript2 being sub-directories of ''C:\XBMC\addons'' each containing the Default.py scripts.&lt;br\&gt;<br /> First you need to define the Python project workspace:<br /> * ''File'' -&gt; ''Switch Workspace'' -&gt; ''Other...''<br /> * ''Browse'' to the parent directory of your script module i.e. ''C:\XBMC\addons'' in this example, select and OK<br /> Then proceed to create the Python project:<br /> * ''File'' -&gt; ''New'' -&gt; ''PyDev Project''<br /> : OR select below in case ''PyDev Project'' is not displayed<br /> * ''File'' -&gt; ''New'' -&gt; ''Others''; and Select ''Pydev'' then ''PyDev Project''; Click ''Next''<br /> * Enter the name of your project e.g. xbmc_addons<br /> * Uncheck option ''Use Default''<br /> * Browse to the directory of your scripts and select i.e. C:\XBMC\addons.<br /> * Set ''Python' as Project Type<br /> * Select ''2.4 (XBMC Python version)'' for the grammar<br /> * Select ''Don't configure PYTHONPATH (to be done manually later on)''<br /> * Click on ''Finish'' button<br /> <br /> <br /> === Set the Python Path ===<br /> * Right click on your new project and select ''Properties''<br /> * Select ''PyDev - PYTHONPATH'' and click on ''Add source folder''<br /> * Select the source directory of your script, /xbmc_addons in our example<br /> <br /> <br /> === Import File System ===<br /> Assuming you want to add in all the directories under C:\XBMC\addons<br /> * Right click on your new project and select ''Import...''<br /> * Select ''General'' and click on ''File System''; then ''Next''<br /> * Browse to the source directory of your script (or plugin) e.g. C:\XBMC\addons<br /> * Check the directory and files to be added<br /> * Select ''Into folder: xbmc_addons''<br /> * Select ''Options | &lt;&lt;Advanced | Create links in workspace''<br /> * Uncheck both the options i.e. ''Create virtual folders'' &amp; ''Create link locations relative to;...''<br /> * Click on ''Finish'' button<br /> Your source code is now recognized by Eclipse and you will have access to neat functionality such as code completion, link between source files, etc.<br /> <br /> <br /> === Add Pydev Python source code (pysrc) to XBMC ===<br /> XBMC needs to know where to find the PyDev remote python source file in order to communicate with the remote debugger of Eclipse.<br /> <br /> ==== Identify where PyDev remote debugger Python files are ====<br /> Python source files should be in you Eclipse installation directory:<br /> &lt;pre&gt;C:\...\eclipse\plugins\org.python.pydev.debug_1.5.5.2010030420\pysrc\&lt;/pre&gt;<br /> In our case we use PyDev 1.5.5. With newer versions of PyDev, the directory structure changed.<br /> &lt;pre&gt;C:\...\eclipse\plugins\org.python.pydev_3.6.0.201406232321\pysrc\&lt;/pre&gt;<br /> Look for org.python.pydev.debug (not core)<br /> <br /> Instructions for Linux users:<br /> <br /> {{Collapse top}}<br /> In new Eclipse versions on Linux, the standard eclipse installation (/usr/share/eclipse/plugins) does not contain the pydev files any more.<br /> The easiest solution is to install the [[Add-on:Pydevd|pydevd-addon]].&lt;br /&gt;<br /> To access this from your addon, your addon.xml has to contain &lt;code&gt;&lt;import addon=&quot;script.module.pydevd&quot; version=&quot;3.4.1&quot;/&gt;&lt;/code&gt;.<br /> {{Collapse bottom}}<br /> <br /> ==== Modify PyDev source in order to support XBMC paths ====<br /> The pysrc code that came with Eclipse-pydev does not support XBMC paths (special://... or Q:/...) and the module would not find them making it impossible to insert breakpoints in such files.<br /> <br /> In order to add the support of XBMC paths, you will need to do a simple modification to the file ''pydevd_file_utils.py'' consisting on adding a line to each procedure that had a filename parameter (4 procedures in total). <br /> Add a line like<br /> <br /> <br /> def _NormFile(filename):<br /> filename = xbmc.translatePath(filename)<br /> try:<br /> ...<br /> <br /> The other three procedures are:<br /> * def _NormFile(filename):<br /> * def NormFileToServer(filename):<br /> * def NormFileToClient(filename):<br /> <br /> of course you need the import directive at the top of the file:<br /> <br /> import xbmc<br /> <br /> at the beginning of the module...<br /> <br /> ==== Choose how XBMC will refer to Pydev debugging module ====<br /> <br /> You have 3 options as below:<br /> * Option 1 - Refer from our python script directly the directory where pysrc is installed<br /> * Option 2 - Copy pysrc in our script directory and refer it from our script<br /> * Option 3 - Copy pysrc in XBMC Python install<br /> * Option 4 - Use the pydev from the [[Add-on:Pydevd|pydevd-addon]]<br /> <br /> I am only going to show you the steps for ''Option 3'':<br /> <br /> ==== Copy pysrc in XBMC Python install ====<br /> ===== Option 3: (Suggested for Windows users) =====<br /> * Copy the content of pysrc to:<br /> &lt;pre&gt;XBMC\system\python\Lib\pysrc\&lt;/pre&gt;<br /> * Add an empty __init__.py file in it<br /> <br /> ===== Option 4: (Suggested for Linux users) =====<br /> Use the [[Add-on:Pydevd|pydevd-addon]] as described above. No action necessary. Option 3 does not work on Linux, because /usr/share/kodi/system/python/Lib is ignored.<br /> <br /> === Add to your python script the code for remote debug ===<br /> At the beginning of you Python script/plugin (usually Default.py) add the following code:<br /> &lt;pre&gt;<br /> REMOTE_DBG = True <br /> <br /> # append pydev remote debugger<br /> if REMOTE_DBG:<br /> # Make pydev debugger works for auto reload.<br /> # Note pydevd module need to be copied in XBMC\system\python\Lib\pysrc<br /> try:<br /> import pysrc.pydevd as pydevd<br /> # stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console<br /> pydevd.settrace('localhost', stdoutToServer=True, stderrToServer=True)<br /> except ImportError:<br /> sys.stderr.write(&quot;Error: &quot; +<br /> &quot;You must add org.python.pydev.debug.pysrc to your PYTHONPATH.&quot;)<br /> sys.exit(1)<br /> &lt;/pre&gt;<br /> <br /> In the case you have change the default port you can replace the line with pydevd.settrace by this one:<br /> &lt;pre&gt;<br /> pydevd.settrace('localhost', port=5678, stdoutToServer=True, stderrToServer=True)<br /> &lt;/pre&gt;<br /> <br /> * Use REMOTE_DBG in order to activate or not the remote debugging<br /> * port specifies the listening port number use between the client and the server<br /> * Replace localhost by an IP address if XBMC and Eclipse are on 2 different machines<br /> * stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console, you won't have to open xbmc.log file<br /> <br /> <br /> <br /> === Run ===<br /> * Go in Debug view (Eclipse: [[File:changeperspective.png]] / Debug ) and press on the start server button: [[File:EclipsePydevDebugSrvButtons.png]]<br /> <br /> * You will see in the console logs like:<br /> &lt;pre&gt;Debug Server at port: 5678&lt;/pre&gt;<br /> <br /> * Start XBMC and run your script/plugin, you will see it as &quot;Running&quot; but paused<br /> <br /> * In Eclipse (Debug View) click on the Resume button (or F8), then you will see the program running in XBMC<br /> <br /> * You are now fully set up: You can set break-point, watch on variables, run step by step etc<br /> <br /> * Enjoy!<br /> <br /> === Screenshot ===<br /> <br /> [[File:EclipsePydevDebugger.png]]<br /> <br /> ==See also==<br /> * [[Add-ons]]<br /> * [[:Category:All add-ons]]<br /> * [[3rd party add-on repositories]]<br /> '''Development:'''<br /> * [[Add-on development]]<br /> * [[Addon Settings]]<br /> * [[Python development]]<br /> * [[Add-on repositories]]<br /> * [[Official add-on repository]]<br /> <br /> [[Category:Python]]<br /> [[Category:How-to]]<br /> [[Category:Add-on development]]</div>

Schapplm https://kodi.wiki/index.php?title=Archive:Debug_Python_Scripts_with_Eclipse&diff=83937 2015-01-11T15:13:27Z

<p>Schapplm: /* Choose how XBMC will refer to Pydev debugging module */</p> <hr /> <div>{{mininav|[[Development]]|[[Add-on development]]|[[Python development]]}}<br /> <br /> Here is a method you can adopt in order to use the Eclipse (multi-platforms) remote debugger with your Python scripts/plugin.<br /> <br /> Note: Follow this link [[HOW-TO debug Python Scripts|Debugging Python Scripts on Linux with WinPDB]] for more information if you prefer to use WinPDB instead.<br /> <br /> Note: The information provided herein is also applicable to user with [http://www.aptana.com/ Aptana Studio 3] installation which come pre-installed with pydev. For this case, you can skip to [[#Configure Pydev and Eclipse|Configure Pydev and Eclipse]] after the Aptana Studio 3 installation.<br /> <br /> <br /> <br /> == Prerequisite ==<br /> * Any platform able to run [http://www.eclipse.org/downloads/ Eclipse IDE] (Windows 32bit-64bit, Mac Carbon 32bit-64bit, Mac Cocoa 32bit-64bit, Linux 32bit-64bit): it is the platform from where you will run the debugger IDE<br /> * Python interpreter 2.4 (use the same version as XBMC or version &lt;= 2.7 ) install on the machine running Eclipse<br /> * Any platform running XBMC (Xbox, Linux, MACOSX, Windows): it is the platform running Python scripts/plugin connecting with the remote debugger.<br /> :XBMC installed on Ubuntu (should work just fine on Windows and Mac too)<br /> * [http://pydev.org/ Pydev] plugin for Eclipse IDE: Pydev is a Python IDE for Eclipse, which may be used in Python, Jython and IronPython development.<br /> <br /> == Prepare and Setup Eclipse ==<br /> <br /> === Install Eclipse ===<br /> * Download [http://www.eclipse.org/downloads/ Eclipse IDE] and install it<br /> Note: in our example Eclipse Galileo (3.5.1) is used<br /> <br /> <br /> <br /> === Install Pydev in Eclipse ===<br /> * In Eclipse go in: ''Help'' -&gt; ''Install New Software...''<br /> * Click on the ''Add'' button and add Pydev website as a source: http://pydev.org/updates<br /> * You will see the window below:<br /> [[File:EclipsePydevUpdate.png]]<br /> * Check ''PyDev'' box and follow the steps in order to install PyDev<br /> Note: in our example PyDev 1.5.5<br /> <br /> <br /> <br /> === Configure Pydev and Eclipse ===<br /> <br /> <br /> ==== Add Python Interpreter Path ====<br /> * Go in ''Window'' -&gt; ''Preferences''<br /> * ''Pydev'' then ''Interpreter - Python''<br /> * Click on button ''New...''<br /> * In the new prompt, enter the ''Interpreter Name: Python'', and Browse for your Python Interpreter 2.4 ''python.exe'' file and select it. After that you should see something like this:<br /> [[File:EclipsePydevPref.png|none]]<br /> This will help in order to have Python code completion (except for XBMC modules)<br /> <br /> ==== Add Pydev view to Eclipse ====<br /> * On the top right corner click on the View button on select ''Others''<br /> [[File:EclipsePydevViewMenu.png]]<br /> * Select Pydev then OK, a PyDev View Button should be now available on the top right corner<br /> [[File:EclipsePydevViewMenu2.png]]<br /> Use this view for your developments in Python for XBMC<br /> <br /> <br /> ==== Add Pydev Start/Stop debug server buttons ====<br /> * In the menu bar select ''Window'' -&gt; ''Customize perspective...'', a window ''Customize Perspective - PyDev'' will open<br /> * Select ''Command Groups Availability'' Tab<br /> * Check ''Pydev Debug'' box and OK<br /> * You should see 2 new buttons in your toolbar:<br /> [[File:EclipsePydevDebugSrvButtons.png]]<br /> <br /> <br /> ==== Setting the remote debugger port (optional) ====<br /> If you do not want to use the default port (usually 5678) you can set it up:<br /> * Go to ''Window'' -&gt; ''Preferences''<br /> * ''Pydev'' then ''Debug'' you can define here the port and the timeout you want<br /> <br /> ==== Setting up Predefined Completions (optional) ====<br /> Many developers are accustom to using predefined completions when writing their code (eg. type-ahead). The standard Python completions are enabled by default when using these instructions, but the standard XBMC components will not be recognized appropriately (xbmc, xbmcgui, xbmcplugin, etc). <br /> <br /> In order to overcome this, you can run the [http://forum.xbmc.org/showthread.php?t=79070 PyDev Predefined Completions Creator addon] and [http://pydev.org/manual_101_interpreter.html#PyDevInterpreterConfiguration-PredefinedCompletions setup Eclipse] to reference this file:<br /> # Download the 'PyDev Predefined Completions Creator' Addon (eg. System &gt; Settings &gt; Addons &gt; XBMC.org &gt; Program Add-Ons)<br /> # Navigate to the newly installed Addon (eg. Programs from the home screen)<br /> # Open the context menu for newly installed addon and select 'Add-on Settings'<br /> # Set the location to save the help docs to and save the new settings (This can be anywhere on your system - we'll configure it in Eclipse later)<br /> # Select the add-on to run it (the addon should run and close quickly)<br /> # Open Eclipse and select Window &gt; Preferences &gt; PyDev &gt; Interpreter - Python<br /> # From the 'Predefined' tab, click the new button and select the folder you created in the step above<br /> # Press Apply / OK to ensure the changes are saved<br /> <br /> == Create a Python script/plugin for XBMC in Eclipse ==<br /> <br /> <br /> === Create a new PyDev Project ===<br /> Most of the time when you are doing development, likely that you are running XBMC and Eclipse on the same platform; (The installed debugger described in this article actually can also work with a remote XBMC).&lt;br\&gt;<br /> Let's say you already have scripts installed in XBMC script folder that you want to create a new PyDev project e.g.<br /> &lt;pre&gt;<br /> C:\XBMC\addons\myscript1<br /> C:\XBMC\addons\myscript2<br /> &lt;/pre&gt;<br /> <br /> With myscript1 &amp; myscript2 being sub-directories of ''C:\XBMC\addons'' each containing the Default.py scripts.&lt;br\&gt;<br /> First you need to define the Python project workspace:<br /> * ''File'' -&gt; ''Switch Workspace'' -&gt; ''Other...''<br /> * ''Browse'' to the parent directory of your script module i.e. ''C:\XBMC\addons'' in this example, select and OK<br /> Then proceed to create the Python project:<br /> * ''File'' -&gt; ''New'' -&gt; ''PyDev Project''<br /> : OR select below in case ''PyDev Project'' is not displayed<br /> * ''File'' -&gt; ''New'' -&gt; ''Others''; and Select ''Pydev'' then ''PyDev Project''; Click ''Next''<br /> * Enter the name of your project e.g. xbmc_addons<br /> * Uncheck option ''Use Default''<br /> * Browse to the directory of your scripts and select i.e. C:\XBMC\addons.<br /> * Set ''Python' as Project Type<br /> * Select ''2.4 (XBMC Python version)'' for the grammar<br /> * Select ''Don't configure PYTHONPATH (to be done manually later on)''<br /> * Click on ''Finish'' button<br /> <br /> <br /> === Set the Python Path ===<br /> * Right click on your new project and select ''Properties''<br /> * Select ''PyDev - PYTHONPATH'' and click on ''Add source folder''<br /> * Select the source directory of your script, /xbmc_addons in our example<br /> <br /> <br /> === Import File System ===<br /> Assuming you want to add in all the directories under C:\XBMC\addons<br /> * Right click on your new project and select ''Import...''<br /> * Select ''General'' and click on ''File System''; then ''Next''<br /> * Browse to the source directory of your script (or plugin) e.g. C:\XBMC\addons<br /> * Check the directory and files to be added<br /> * Select ''Into folder: xbmc_addons''<br /> * Select ''Options | &lt;&lt;Advanced | Create links in workspace''<br /> * Uncheck both the options i.e. ''Create virtual folders'' &amp; ''Create link locations relative to;...''<br /> * Click on ''Finish'' button<br /> Your source code is now recognized by Eclipse and you will have access to neat functionality such as code completion, link between source files, etc.<br /> <br /> <br /> === Add Pydev Python source code (pysrc) to XBMC ===<br /> XBMC needs to know where to find the PyDev remote python source file in order to communicate with the remote debugger of Eclipse.<br /> <br /> ==== Identify where PyDev remote debugger Python files are ====<br /> Python source files should be in you Eclipse installation directory:<br /> &lt;pre&gt;C:\...\eclipse\plugins\org.python.pydev.debug_1.5.5.2010030420\pysrc\&lt;/pre&gt;<br /> In our case we use PyDev 1.5.5. With newer versions of PyDev, the directory structure changed.<br /> &lt;pre&gt;C:\...\eclipse\plugins\org.python.pydev_3.6.0.201406232321\pysrc\&lt;/pre&gt;<br /> Look for org.python.pydev.debug (not core)<br /> <br /> Instructions for Linux users:<br /> <br /> {{Collapse top}}<br /> In new Eclipse versions on Linux, the standard eclipse installation (/usr/share/eclipse/plugins) does not contain the pydev files any more.<br /> The easiest solution is to install the [[Add-on:Pydevd|pydevd-addon]].&lt;br /&gt;<br /> To access this from your addon, your addon.xml has to contain &lt;code&gt;&lt;import addon=&quot;script.module.pydevd&quot; version=&quot;3.4.1&quot;/&gt;&lt;/code&gt;.<br /> {{Collapse bottom}}<br /> <br /> ==== Modify PyDev source in order to support XBMC paths ====<br /> The pysrc code that came with Eclipse-pydev does not support XBMC paths (special://... or Q:/...) and the module would not find them making it impossible to insert breakpoints in such files.<br /> <br /> In order to add the support of XBMC paths, you will need to do a simple modification to the file ''pydevd_file_utils.py'' consisting on adding a line to each procedure that had a filename parameter (4 procedures in total). <br /> Add a line like<br /> <br /> <br /> def _NormFile(filename):<br /> filename = xbmc.translatePath(filename)<br /> try:<br /> ...<br /> <br /> The other three procedures are:<br /> * def _NormFile(filename):<br /> * def NormFileToServer(filename):<br /> * def NormFileToClient(filename):<br /> <br /> of course you need the import directive at the top of the file:<br /> <br /> import xbmc<br /> <br /> at the beginning of the module...<br /> <br /> ==== Choose how XBMC will refer to Pydev debugging module ====<br /> <br /> You have 3 options as below:<br /> * Option 1 - Refer from our python script directly the directory where pysrc is installed<br /> * Option 2 - Copy pysrc in our script directory and refer it from our script<br /> * Option 3 - Copy pysrc in XBMC Python install<br /> * Option 4 - Use the pydev from the [[Add-on:Pydevd|pydevd-addon]]<br /> <br /> I am only going to show you the steps for ''Option 3'':<br /> <br /> ==== Copy pysrc in XBMC Python install ====<br /> * Copy the content of pysrc to:<br /> &lt;pre&gt;XBMC\system\python\Lib\pysrc\&lt;/pre&gt;<br /> * Add an empty __init__.py file in it<br /> <br /> === Add to your python script the code for remote debug ===<br /> At the beginning of you Python script/plugin (usually Default.py) add the following code:<br /> &lt;pre&gt;<br /> REMOTE_DBG = True <br /> <br /> # append pydev remote debugger<br /> if REMOTE_DBG:<br /> # Make pydev debugger works for auto reload.<br /> # Note pydevd module need to be copied in XBMC\system\python\Lib\pysrc<br /> try:<br /> import pysrc.pydevd as pydevd<br /> # stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console<br /> pydevd.settrace('localhost', stdoutToServer=True, stderrToServer=True)<br /> except ImportError:<br /> sys.stderr.write(&quot;Error: &quot; +<br /> &quot;You must add org.python.pydev.debug.pysrc to your PYTHONPATH.&quot;)<br /> sys.exit(1)<br /> &lt;/pre&gt;<br /> <br /> In the case you have change the default port you can replace the line with pydevd.settrace by this one:<br /> &lt;pre&gt;<br /> pydevd.settrace('localhost', port=5678, stdoutToServer=True, stderrToServer=True)<br /> &lt;/pre&gt;<br /> <br /> * Use REMOTE_DBG in order to activate or not the remote debugging<br /> * port specifies the listening port number use between the client and the server<br /> * Replace localhost by an IP address if XBMC and Eclipse are on 2 different machines<br /> * stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console, you won't have to open xbmc.log file<br /> <br /> <br /> <br /> === Run ===<br /> * Go in Debug view (Eclipse: [[File:changeperspective.png]] / Debug ) and press on the start server button: [[File:EclipsePydevDebugSrvButtons.png]]<br /> <br /> * You will see in the console logs like:<br /> &lt;pre&gt;Debug Server at port: 5678&lt;/pre&gt;<br /> <br /> * Start XBMC and run your script/plugin, you will see it as &quot;Running&quot; but paused<br /> <br /> * In Eclipse (Debug View) click on the Resume button (or F8), then you will see the program running in XBMC<br /> <br /> * You are now fully set up: You can set break-point, watch on variables, run step by step etc<br /> <br /> * Enjoy!<br /> <br /> === Screenshot ===<br /> <br /> [[File:EclipsePydevDebugger.png]]<br /> <br /> ==See also==<br /> * [[Add-ons]]<br /> * [[:Category:All add-ons]]<br /> * [[3rd party add-on repositories]]<br /> '''Development:'''<br /> * [[Add-on development]]<br /> * [[Addon Settings]]<br /> * [[Python development]]<br /> * [[Add-on repositories]]<br /> * [[Official add-on repository]]<br /> <br /> [[Category:Python]]<br /> [[Category:How-to]]<br /> [[Category:Add-on development]]</div>

Schapplm https://kodi.wiki/index.php?title=Archive:Debug_Python_Scripts_with_Eclipse&diff=83936 2015-01-11T15:11:22Z

<p>Schapplm: /* Identify where PyDev remote debugger Python files are */</p> <hr /> <div>{{mininav|[[Development]]|[[Add-on development]]|[[Python development]]}}<br /> <br /> Here is a method you can adopt in order to use the Eclipse (multi-platforms) remote debugger with your Python scripts/plugin.<br /> <br /> Note: Follow this link [[HOW-TO debug Python Scripts|Debugging Python Scripts on Linux with WinPDB]] for more information if you prefer to use WinPDB instead.<br /> <br /> Note: The information provided herein is also applicable to user with [http://www.aptana.com/ Aptana Studio 3] installation which come pre-installed with pydev. For this case, you can skip to [[#Configure Pydev and Eclipse|Configure Pydev and Eclipse]] after the Aptana Studio 3 installation.<br /> <br /> <br /> <br /> == Prerequisite ==<br /> * Any platform able to run [http://www.eclipse.org/downloads/ Eclipse IDE] (Windows 32bit-64bit, Mac Carbon 32bit-64bit, Mac Cocoa 32bit-64bit, Linux 32bit-64bit): it is the platform from where you will run the debugger IDE<br /> * Python interpreter 2.4 (use the same version as XBMC or version &lt;= 2.7 ) install on the machine running Eclipse<br /> * Any platform running XBMC (Xbox, Linux, MACOSX, Windows): it is the platform running Python scripts/plugin connecting with the remote debugger.<br /> :XBMC installed on Ubuntu (should work just fine on Windows and Mac too)<br /> * [http://pydev.org/ Pydev] plugin for Eclipse IDE: Pydev is a Python IDE for Eclipse, which may be used in Python, Jython and IronPython development.<br /> <br /> == Prepare and Setup Eclipse ==<br /> <br /> === Install Eclipse ===<br /> * Download [http://www.eclipse.org/downloads/ Eclipse IDE] and install it<br /> Note: in our example Eclipse Galileo (3.5.1) is used<br /> <br /> <br /> <br /> === Install Pydev in Eclipse ===<br /> * In Eclipse go in: ''Help'' -&gt; ''Install New Software...''<br /> * Click on the ''Add'' button and add Pydev website as a source: http://pydev.org/updates<br /> * You will see the window below:<br /> [[File:EclipsePydevUpdate.png]]<br /> * Check ''PyDev'' box and follow the steps in order to install PyDev<br /> Note: in our example PyDev 1.5.5<br /> <br /> <br /> <br /> === Configure Pydev and Eclipse ===<br /> <br /> <br /> ==== Add Python Interpreter Path ====<br /> * Go in ''Window'' -&gt; ''Preferences''<br /> * ''Pydev'' then ''Interpreter - Python''<br /> * Click on button ''New...''<br /> * In the new prompt, enter the ''Interpreter Name: Python'', and Browse for your Python Interpreter 2.4 ''python.exe'' file and select it. After that you should see something like this:<br /> [[File:EclipsePydevPref.png|none]]<br /> This will help in order to have Python code completion (except for XBMC modules)<br /> <br /> ==== Add Pydev view to Eclipse ====<br /> * On the top right corner click on the View button on select ''Others''<br /> [[File:EclipsePydevViewMenu.png]]<br /> * Select Pydev then OK, a PyDev View Button should be now available on the top right corner<br /> [[File:EclipsePydevViewMenu2.png]]<br /> Use this view for your developments in Python for XBMC<br /> <br /> <br /> ==== Add Pydev Start/Stop debug server buttons ====<br /> * In the menu bar select ''Window'' -&gt; ''Customize perspective...'', a window ''Customize Perspective - PyDev'' will open<br /> * Select ''Command Groups Availability'' Tab<br /> * Check ''Pydev Debug'' box and OK<br /> * You should see 2 new buttons in your toolbar:<br /> [[File:EclipsePydevDebugSrvButtons.png]]<br /> <br /> <br /> ==== Setting the remote debugger port (optional) ====<br /> If you do not want to use the default port (usually 5678) you can set it up:<br /> * Go to ''Window'' -&gt; ''Preferences''<br /> * ''Pydev'' then ''Debug'' you can define here the port and the timeout you want<br /> <br /> ==== Setting up Predefined Completions (optional) ====<br /> Many developers are accustom to using predefined completions when writing their code (eg. type-ahead). The standard Python completions are enabled by default when using these instructions, but the standard XBMC components will not be recognized appropriately (xbmc, xbmcgui, xbmcplugin, etc). <br /> <br /> In order to overcome this, you can run the [http://forum.xbmc.org/showthread.php?t=79070 PyDev Predefined Completions Creator addon] and [http://pydev.org/manual_101_interpreter.html#PyDevInterpreterConfiguration-PredefinedCompletions setup Eclipse] to reference this file:<br /> # Download the 'PyDev Predefined Completions Creator' Addon (eg. System &gt; Settings &gt; Addons &gt; XBMC.org &gt; Program Add-Ons)<br /> # Navigate to the newly installed Addon (eg. Programs from the home screen)<br /> # Open the context menu for newly installed addon and select 'Add-on Settings'<br /> # Set the location to save the help docs to and save the new settings (This can be anywhere on your system - we'll configure it in Eclipse later)<br /> # Select the add-on to run it (the addon should run and close quickly)<br /> # Open Eclipse and select Window &gt; Preferences &gt; PyDev &gt; Interpreter - Python<br /> # From the 'Predefined' tab, click the new button and select the folder you created in the step above<br /> # Press Apply / OK to ensure the changes are saved<br /> <br /> == Create a Python script/plugin for XBMC in Eclipse ==<br /> <br /> <br /> === Create a new PyDev Project ===<br /> Most of the time when you are doing development, likely that you are running XBMC and Eclipse on the same platform; (The installed debugger described in this article actually can also work with a remote XBMC).&lt;br\&gt;<br /> Let's say you already have scripts installed in XBMC script folder that you want to create a new PyDev project e.g.<br /> &lt;pre&gt;<br /> C:\XBMC\addons\myscript1<br /> C:\XBMC\addons\myscript2<br /> &lt;/pre&gt;<br /> <br /> With myscript1 &amp; myscript2 being sub-directories of ''C:\XBMC\addons'' each containing the Default.py scripts.&lt;br\&gt;<br /> First you need to define the Python project workspace:<br /> * ''File'' -&gt; ''Switch Workspace'' -&gt; ''Other...''<br /> * ''Browse'' to the parent directory of your script module i.e. ''C:\XBMC\addons'' in this example, select and OK<br /> Then proceed to create the Python project:<br /> * ''File'' -&gt; ''New'' -&gt; ''PyDev Project''<br /> : OR select below in case ''PyDev Project'' is not displayed<br /> * ''File'' -&gt; ''New'' -&gt; ''Others''; and Select ''Pydev'' then ''PyDev Project''; Click ''Next''<br /> * Enter the name of your project e.g. xbmc_addons<br /> * Uncheck option ''Use Default''<br /> * Browse to the directory of your scripts and select i.e. C:\XBMC\addons.<br /> * Set ''Python' as Project Type<br /> * Select ''2.4 (XBMC Python version)'' for the grammar<br /> * Select ''Don't configure PYTHONPATH (to be done manually later on)''<br /> * Click on ''Finish'' button<br /> <br /> <br /> === Set the Python Path ===<br /> * Right click on your new project and select ''Properties''<br /> * Select ''PyDev - PYTHONPATH'' and click on ''Add source folder''<br /> * Select the source directory of your script, /xbmc_addons in our example<br /> <br /> <br /> === Import File System ===<br /> Assuming you want to add in all the directories under C:\XBMC\addons<br /> * Right click on your new project and select ''Import...''<br /> * Select ''General'' and click on ''File System''; then ''Next''<br /> * Browse to the source directory of your script (or plugin) e.g. C:\XBMC\addons<br /> * Check the directory and files to be added<br /> * Select ''Into folder: xbmc_addons''<br /> * Select ''Options | &lt;&lt;Advanced | Create links in workspace''<br /> * Uncheck both the options i.e. ''Create virtual folders'' &amp; ''Create link locations relative to;...''<br /> * Click on ''Finish'' button<br /> Your source code is now recognized by Eclipse and you will have access to neat functionality such as code completion, link between source files, etc.<br /> <br /> <br /> === Add Pydev Python source code (pysrc) to XBMC ===<br /> XBMC needs to know where to find the PyDev remote python source file in order to communicate with the remote debugger of Eclipse.<br /> <br /> ==== Identify where PyDev remote debugger Python files are ====<br /> Python source files should be in you Eclipse installation directory:<br /> &lt;pre&gt;C:\...\eclipse\plugins\org.python.pydev.debug_1.5.5.2010030420\pysrc\&lt;/pre&gt;<br /> In our case we use PyDev 1.5.5. With newer versions of PyDev, the directory structure changed.<br /> &lt;pre&gt;C:\...\eclipse\plugins\org.python.pydev_3.6.0.201406232321\pysrc\&lt;/pre&gt;<br /> Look for org.python.pydev.debug (not core)<br /> <br /> Instructions for Linux users:<br /> <br /> {{Collapse top}}<br /> In new Eclipse versions on Linux, the standard eclipse installation (/usr/share/eclipse/plugins) does not contain the pydev files any more.<br /> The easiest solution is to install the [[Add-on:Pydevd|pydevd-addon]].&lt;br /&gt;<br /> To access this from your addon, your addon.xml has to contain &lt;code&gt;&lt;import addon=&quot;script.module.pydevd&quot; version=&quot;3.4.1&quot;/&gt;&lt;/code&gt;.<br /> {{Collapse bottom}}<br /> <br /> ==== Modify PyDev source in order to support XBMC paths ====<br /> The pysrc code that came with Eclipse-pydev does not support XBMC paths (special://... or Q:/...) and the module would not find them making it impossible to insert breakpoints in such files.<br /> <br /> In order to add the support of XBMC paths, you will need to do a simple modification to the file ''pydevd_file_utils.py'' consisting on adding a line to each procedure that had a filename parameter (4 procedures in total). <br /> Add a line like<br /> <br /> <br /> def _NormFile(filename):<br /> filename = xbmc.translatePath(filename)<br /> try:<br /> ...<br /> <br /> The other three procedures are:<br /> * def _NormFile(filename):<br /> * def NormFileToServer(filename):<br /> * def NormFileToClient(filename):<br /> <br /> of course you need the import directive at the top of the file:<br /> <br /> import xbmc<br /> <br /> at the beginning of the module...<br /> <br /> ==== Choose how XBMC will refer to Pydev debugging module ====<br /> <br /> You have 3 options as below:<br /> * Option 1 - Refer from our python script directly the directory where pysrc is installed<br /> * Option 2 - Copy pysrc in our script directory and refer it from our script<br /> * Option 3 - Copy pysrc in XBMC Python install<br /> <br /> I am only going to show you the steps for ''Option 3'':<br /> <br /> ==== Copy pysrc in XBMC Python install ====<br /> * Copy the content of pysrc to:<br /> &lt;pre&gt;XBMC\system\python\Lib\pysrc\&lt;/pre&gt;<br /> * Add an empty __init__.py file in it<br /> <br /> === Add to your python script the code for remote debug ===<br /> At the beginning of you Python script/plugin (usually Default.py) add the following code:<br /> &lt;pre&gt;<br /> REMOTE_DBG = True <br /> <br /> # append pydev remote debugger<br /> if REMOTE_DBG:<br /> # Make pydev debugger works for auto reload.<br /> # Note pydevd module need to be copied in XBMC\system\python\Lib\pysrc<br /> try:<br /> import pysrc.pydevd as pydevd<br /> # stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console<br /> pydevd.settrace('localhost', stdoutToServer=True, stderrToServer=True)<br /> except ImportError:<br /> sys.stderr.write(&quot;Error: &quot; +<br /> &quot;You must add org.python.pydev.debug.pysrc to your PYTHONPATH.&quot;)<br /> sys.exit(1)<br /> &lt;/pre&gt;<br /> <br /> In the case you have change the default port you can replace the line with pydevd.settrace by this one:<br /> &lt;pre&gt;<br /> pydevd.settrace('localhost', port=5678, stdoutToServer=True, stderrToServer=True)<br /> &lt;/pre&gt;<br /> <br /> * Use REMOTE_DBG in order to activate or not the remote debugging<br /> * port specifies the listening port number use between the client and the server<br /> * Replace localhost by an IP address if XBMC and Eclipse are on 2 different machines<br /> * stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console, you won't have to open xbmc.log file<br /> <br /> <br /> <br /> === Run ===<br /> * Go in Debug view (Eclipse: [[File:changeperspective.png]] / Debug ) and press on the start server button: [[File:EclipsePydevDebugSrvButtons.png]]<br /> <br /> * You will see in the console logs like:<br /> &lt;pre&gt;Debug Server at port: 5678&lt;/pre&gt;<br /> <br /> * Start XBMC and run your script/plugin, you will see it as &quot;Running&quot; but paused<br /> <br /> * In Eclipse (Debug View) click on the Resume button (or F8), then you will see the program running in XBMC<br /> <br /> * You are now fully set up: You can set break-point, watch on variables, run step by step etc<br /> <br /> * Enjoy!<br /> <br /> === Screenshot ===<br /> <br /> [[File:EclipsePydevDebugger.png]]<br /> <br /> ==See also==<br /> * [[Add-ons]]<br /> * [[:Category:All add-ons]]<br /> * [[3rd party add-on repositories]]<br /> '''Development:'''<br /> * [[Add-on development]]<br /> * [[Addon Settings]]<br /> * [[Python development]]<br /> * [[Add-on repositories]]<br /> * [[Official add-on repository]]<br /> <br /> [[Category:Python]]<br /> [[Category:How-to]]<br /> [[Category:Add-on development]]</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:DailyMotion.com&diff=82720 2014-12-28T18:12:39Z

<p>Schapplm: </p> <hr /> <div>{{Addon <br /> |Name=DailyMotion.com<br /> |provider-name=AddonScriptorDE<br /> |ID=plugin.video.dailymotion_com<br /> |latest-version=2.1.2<br /> |extension point=xbmc.python.pluginsource<br /> |provides=video<br /> |Summary=Movies, TV, Music, User-Clips, 3D and Livestreams<br /> |Description=Movies, TV, Music, User-Clips, 3D and Livestreams<br /> |Platform=all<br /> |Language=<br /> |License=<br /> |Forum=http://forum.xbmc.org/showthread.php?tid=142626<br /> |Website=http://www.dailymotion.com<br /> |Source=https://github.com/AddonScriptorDE/plugin.video.dailymotion_com<br /> |Email=AddonScriptorDE at yahoo dot de<br /> |broken=<br /> |icon url=http://mirrors.xbmc.org/addons/frodo/plugin.video.dailymotion_com/icon.png}}<br /> <br /> [[Category:Frodo add-on repository]]<br /> <br /> == Features ==<br /> === Integration with strm files ===<br /> DailyMotion streams can be integrated into the video library with [[Strm|strm files]]. <br /> The syntax for a DailyMotion-URL like &lt;code&gt;&lt;nowiki&gt;http://www.dailymotion.com/video/%VIDEOID%_DESCRIPTIONTEXT&lt;/nowiki&gt;&lt;/code&gt; is&lt;br /&gt;<br /> <br /> &lt;code&gt;plugin://plugin.video.dailymotion_com/?url=%VIDEOID%&amp;mode=playVideo&lt;/code&gt;</div>

Schapplm https://kodi.wiki/index.php?title=Add-on:YouTube&diff=82716 2014-12-28T17:48:12Z

<p>Schapplm: /* Unofficial Browser extensions */</p> <hr /> <div>{{forum link2|For more information and support see the [[forum:79487|YouTube add-on discussion thread]]}}<br /> {{Addon <br /> |Name=YouTube<br /> |provider-name=TheCollective<br /> |ID=plugin.video.youtube<br /> |latest-version=4.4.10<br /> |extension point=xbmc.python.pluginsource<br /> |provides=video<br /> |Summary=YouTube video plugin<br /> |Description=Plugin that lets you browse and play videos from everybody's favorite video site!<br /> |Platform=all<br /> |Language=<br /> |License=<br /> |Forum=<br /> |Website=<br /> |Source=<br /> |Email=<br /> |broken=<br /> |icon url=http://mirrors.xbmc.org/addons/frodo/plugin.video.youtube/icon.png}}<br /> <br /> = Introduction =<br /> <br /> In order to use this plugin you will need Dharma 10.1 or newer release of XBMC.<br /> <br /> {{bluev|NOTICE:|Changes in our development methodology have made it necessary to put the stable version of the plugin on life support. Some non-working features have been disabled as it wasn't feasible to repair them.}}<br /> <br /> All functions are enabled if you are running an Eden v11 or newer version of XBMC.<br /> <br /> == Features ==<br /> * Non-intrusive user notifications<br /> * Video thumbnail browsing for a more pleasant user experience<br /> * Advanced Searching (including locally stored searches)<br /> * Listing of [http://www.youtube.com/ YouTube's] standard feeds and region specific feeds<br /> * Adding and removing contacts<br /> * Adding and removing favorites<br /> * Subscribing and unsubscribing<br /> * Listing Subscriptions including new subscription videos<br /> * Listing a contacts uploads, playlists, favorite videos and subscriptions<br /> * Playback of all video streams (RTMP support is currently not working due to limitations in rtmpdump)<br /> * Plays videos that can't be embedded<br /> * Auto-magically filters unavailable video's from [http://www.youtube.com/ YouTube's] results (If you see it, you can play it)<br /> * Supports [http://www.youtube.com/ YouTube] Disco! (Music Discovery project) Searches (Beta)<br /> * Supports Browsing [http://www.youtube.com/ YouTube] Categories, Trailers and Shows (Beta)<br /> <br /> === Unofficial Browser extensions ===<br /> The extensions above are known not to work with the newest YouTube and XBMC Eden and newer.<br /> The following unofficial extensions are available:<br /> <br /> Mozilla Firefox<br /> * [https://addons.mozilla.org/en-US/firefox/addon/send-to-xbmc/?src=external-xbmcwiki Send to XBMC]<br /> <br /> Google Chrome<br /> * [https://chrome.google.com/webstore/detail/play-to-xbmc/fncjhcjfnnooidlkijollckpakkebden Play to XBMC]<br /> * [https://chrome.google.com/webstore/detail/playlist2xbmc/mgajimdehjbpldnldemmfigkepdahkik Playlist2XBMC]<br /> * [https://chrome.google.com/webstore/detail/youtube-to-xbmc/gbghegmimhjemkhpimohkdopkeahldbh Youtube to XBMC] (works with Gotham)<br /> <br /> Greasemonkey<br /> * [http://userscripts.org/scripts/show/136934 YouTube » XBMC]<br /> <br /> === Integration with strm files ===<br /> Youtube streams can be integrated into the video library with [[Strm|strm files]]. <br /> The syntax for a youtube-URL like &lt;nowiki&gt;https://www.youtube.com/watch?v=$VIDEOID&lt;/nowiki&gt; is&lt;br /&gt;<br /> <br /> &lt;code&gt;plugin://plugin.video.youtube/?path=/root/video&amp;action=play_video&amp;videoid=$VIDEOID&lt;/code&gt;<br /> <br /> = Known problems =<br /> * One of the main features of the plugin is that it defaults to thumbnails view for video items. This only works when using the default &quot;Confluence&quot; skin as the plugin is dependent on the Id defined for confluences thumbnails view.<br /> <br /> * [http://www.youtube.com/ YouTube] also supports exposing videos through [http://en.wikipedia.org/wiki/Protected_Streaming Adobes RTMPE Protected streaming protocol]. But due to missing support for &quot;RTMPE type 10 handshakes&quot; in the [http://rtmpdump.mplayerhq.hu/ rtmpdump] library, playback is currently not working.<br /> <br /> = Feature request =<br /> If you have a feature request then create a new post in the [http://forum.xbmc.org/showthread.php?t=79487 YouTube support thread].<br /> <br /> = Reporting a bug =<br /> If you are having problems with the plugin or just have a query please do read the documentation and do a search on the XBMC [http://forum.xbmc.org/showthread.php?t=79487 YouTube support thread] before posting.<br /> <br /> If you believe you have found a new bug, create a log (see below) and post in the [http://forum.xbmc.org/showthread.php?t=79487 YouTube support thread].<br /> <br /> == Creating a useful debug log ==<br /> Typically users will report errors with descriptions that lack many important details. While we take all user reported errors seriously, its often is impossible to help if without a proper debug-log, this guide will take you through the steps to create such a log. <br /> <br /> As such, if you want any help with this issue you must follow these steps.<br /> # Open the plugin and go to &quot;Advanced&quot; in settings, enable &quot;Plugin debug&quot; and confirm.<br /> # Find your debug Log here:<br /> * Linux::<br /> $HOME/.xbmc/temp/xbmc.log<br /> * Mac OSX:<br /> $User/Library/Logs/xbmc.log<br /> * Windows 7 &amp; Vista:<br /> \Users\&lt;UserName&gt;\AppData\Roaming\XBMC\xbmc.log<br /> # Paste your debug log to http://pastebin.com/ ( Do NOT upload part of the log, we need the ENTIRE log. )<br /> # Post a message [http://forum.xbmc.org/showthread.php?t=79487 in this thread] with your debug log.<br /> <br /> If you have problems following the guide, please ask on the [http://forum.xbmc.org/showthread.php?t=79487 forum thread] and we will help you through it.<br /> <br /> = Testing/Status =<br /> Integration and unittests are run continuously by Jenkins<br /> <br /> http://tc.tobiasussing.dk/jenkins/view/YouTube/<br /> <br /> =See also=<br /> ===Similar page names===<br /> {{#lst:YouTube|similar pages}}<br /> <br /> [[Category:Frodo add-on repository]]<br /> [[Category:Eden add-on repository]]<br /> [[Category:Social media]]</div>

Schapplm https://kodi.wiki/index.php?title=Archive:MythicalLibrarian&diff=78782 2014-09-13T09:33:25Z

<p>Schapplm: /* Automatic Installation on linux */</p> <hr /> <div>{{mininav| [[Supplemental tools]] }}<br /> [[File:Librarianas.png|left|200px|diagram of how mythicalLibrarian works]]<br /> [[File:Libraraianlibraryfiles2.jpg|right|200px|actual picture from XBMC with recordings from MythTV ]]<br /> [[File:Librararianlibraryfile.jpg|right|200px|actual picture from XBMC with recordings from MythTV ]]<br /> '''The Missing Symlink'''<br /> <br /> &lt;section begin=&quot;intro&quot; /&gt;mythicalLibrarian will convert your [[MythTV]] recordings into a [[Video library]], free of commercials, automatically after recording. You can see an example to the right.&lt;section end=&quot;intro&quot; /&gt;<br /> <br /> <br /> '''About The Program'''<br /> <br /> mythicalLibrarian is a versitile tool designed to assign season and episode numbers to television shows based on show title and episode title so they are easily recognized by XBMC or Boxee. mythicalLibrarian interfaces with TheTvDb to gain information about the target file. mythicalLibrarian also has the ability to interface with MythTV's local database, XBMC's command interface, and Ubuntu GNOME desktop to provide an all-around recording recognition/managing engine which will run in the background of your back-end computer to update your library and provide status updates upon each completed job.<br /> <br /> mythicalLibrarian pulls information supplied by your [[MythTV]] program guide for episodes, and makes a fuzzy logic match out of the supplied data. If fuzzy logic is not enough, it will match original air date. For Movies, mythicalLibrarian will rename your MythTV recordings based upon information obtained from the program guide database on your computer. If you allow commercial data to be generated for your shows, mythicalLibrarian will also copy this data with the recordings. mythicalLibrarian allows MythTV to remain in control of the files, so there is no reason not to process your recordings for boxee and XBMC.<br /> <br /> MythicalLibrarian was designed to run under Ubuntu Karmic Koala OS through BASH 4.0<br /> <br /> <br /> [[File:Files.mythicalfilesystemthumb.jpg|right|thumb|250px|Click this link to see folder layout http://wiki.xbmc.org/images/5/5f/Files.mythicalfilesystem.gif ]][[File:MythicalDBaseThumb.jpg|right|thumb|250px|Click this link to see an example database http://wiki.xbmc.org/images/e/ed/MythicalDBasea.jpg ]]<br /> '''How it works'''<br /> <br /> mythicalLibrarian will generate several files of it's own while running. It must have it's own working directory. To the right, you can see an example of the layout of /mythicalLibrarian, the files which it creates and their purposes.<br /> Here is the basic flow:<br /> * You put in- 'mythicalLibrarian &quot;file/to/process.ext&quot; &quot;episode or movie title&quot; &quot;episode subtitle&quot;<br /> * Episodes- mythicalLibrarian references TheTvDb to gain SeriesID. Get current time from TheTvDb If the database is out-of-date or non existant, it will download the full series and parse it. Then, using fuzzy logic, it makes a match of the series name and gains season and episode information. If this is not possible, it will attempt a match of original airdate from your MythTV program guide database.<br /> mythicalLibrarian will rename your recognizable episodes to: &quot;'''''/Show Name/Show Name.SxxExx (episode subtitle).ext'''''&quot;<br /> * Movies- mythicalLibrarian references your MythTV program guide database to verify it is a movie and then obtains the year for the movie.<br /> mythicalLibrarian will rename your movies to: &quot;'''''/Movie Name/movie title (Year).ext'''''&quot;<br /> * Showings or no TVDB info- mythicalLibrarian will skip all processing and rename the files to &quot;'''''/Show Name/Show Name.S0E0 (episode subtitle).ext'''''&quot;<br /> <br /> '''Deployment'''<br /> <br /> While it is possible to manually configure the script, this may lead to configuration issues. mythicalLibrarian utilizes an advanced easy installation method which allows you to choose between using the latest stable version, or the current version located on your computer. As of right now, the SVN is updated daily, so take advantage of this easy deployment method to increase your features and functions. All users are encouraged to use the SVN version as the primary and in the event of a diagnostic failure, revert to the last stable version. Updating mythicalLibrarian to the newest version is as simple as typing mythicalLibrarian --update and then hitting enter a bunch of times. <br /> <br /> '''Additional Information'''<br /> * Please report problems here in the XBMC Forum thread: http://forum.xbmc.org/showthread.php?p=470402#post470402 <br /> <br /> * If you would like to see additional features and functions, additional back-end support such as tvheadend (and are willing to collect data), or additional guide data type support, please post in this thread http://forum.xbmc.org/showthread.php?t=65769<br /> <br /> <br /> == Installation Setup and Use of mythicalLibrarian ==<br /> This section covers installation, setup, and use of mythicalLibrarian. After completing this section, mythicalLibrarian can run autonomously without user intervention. See the Librarian Interfaces for information on notifications and automation tasks.<br /> <br /> ==== Installation ====<br /> This section covers installation of mythicalLibrarian.<br /> <br /> ===== Automatic Installation on linux =====<br /> This section covers automatic installation and upgrade. Automatic upgrade will allow you to choose between downloading the newest stable, the newest SVN or continuing with the last downloaded version. I encourage SVN usage as it will assist with development.<br /> <br /> * type the following:<br /> sudo apt-get install curl agrep<br /> mkdir ~/.mythicalLibrarian &amp;&amp; mkdir ~/.mythicalLibrarian/mythicalSetup &amp;&amp; cd ~/.mythicalLibrarian/mythicalSetup<br /> curl http://mythicallibrarian.googlecode.com/svn/trunk/mythicalSetup.sh&gt;./mythicalSetup.sh<br /> sudo chmod +x ./mythicalSetup.sh &amp;&amp; sudo ./mythicalSetup.sh<br /> * mythicalSetup's first prompt will ask you to update the working copy of mythicalLibrarian or to continue with setup. If you download a new version, it will bring you back to the same prompt at which point you will select continue. This gives you the option to upgrade, or just configure the current version.<br /> * mythicalSetup will run you through a series of prompts and perform the setup of mythicalLibrarian and all of it's features<br /> <br /> ===== Installation on Mac OS X =====<br /> This section covers installation on Mac OS X. <br /> <br /> ====== Mac OSX Dependencies ======<br /> This section will cover compiling binaries needed for fuzzy logic capabilities and a terminal-based menu-driven interface<br /> <br /> Mac OSX does not have the packages &quot;tre&quot; or &quot;dialog&quot; by default. These packages are required to run mythicalLibrarian and are available through macports. Installation of these packages is required for first time use.<br /> <br /> * Install Xcode Tools <br /> note: You can get Xcode from your OSX installation DVD in &quot;Optional Installs/Xcode Tools/Xcode Tools.pkg&quot; or you can log onto the Mac Dev center at apple.com and download it for free.<br /> * Install X11<br /> note: you can get X11 from your OSX installation DVD in &quot;Optional Installs/Optional Installs.pkg&quot; or you can build it from online sources<br /> * Obtain and install MacPorts <br /> note: you can get MacPorts here: http://distfiles.macports.org/MacPorts/MacPorts-1.8.2.tar.bz2 or navigate to their website here: http://www.macports.org/install.php<br /> * Open Terminal from Finder:Applications/Utilities/Terminal<br /> * Type the following<br /> sudo port install tre<br /> sudo port install dialog<br /> <br /> ====== Automatic Installation on OS X ======<br /> This section will cover installation of mythicalSetup, which will provide an easy interface to install mythicalLibrarian<br /> * Type the following into the Terminal<br /> mkdir ~/.mythicalLibrarian &amp;&amp; mkdir ~/.mythicalLibrarian/mythicalSetup &amp;&amp; cd~/.mythicalLibrarian/mythicalSetup<br /> curl http://mythicallibrarian.googlecode.com/svn/trunk/mythicalSetup.sh&gt;./mythicalSetup.sh<br /> sudo chmod +x ./mythicalSetup.sh &amp;&amp; sudo ./mythicalSetup.sh<br /> * mythicalSetup's first prompt will ask you to update the working copy of mythicalLibrarian or to continue with setup. If you download a new version, it will bring you back to the same prompt at which point you will select continue. This gives you the option to upgrade, or just configure the current version.<br /> * mythicalSetup will run you through a series of prompts and perform the setup of mythicalLibrarian and all of it's features<br /> <br /> ===== Easy Upgrades =====<br /> This section covers upgrading of mythicalLibrarian.<br /> <br /> * type the following<br /> sudo mythicalLibrarian --update<br /> * mythicalLibrarian will download the newest version of mythicalSetup and perform the upgrade. mythicalLibrarian will remember your settings from the last time mythicalSetup was run.<br /> <br /> ===== Manual Installation for Linux =====<br /> This section covers manual installation on Linux. Automatic installation is recommended: see below.<br /> * Install dependencies<br /> sudo apt-get install curl agrep libnotify-bin<br /> dependencies breakdown:<br /> # curl downloads web pages as text. <br /> # agrep or tre provides fuzzy logic. <br /> # libnotify-bin provides GNOME desktop notifications<br /> <br /> * Download the current version of mythcalLibrarian from this [http://mythicallibrarian.googlecode.com/files/mythicalLibrarian download link]<br /> * Place mythicalLibrarianin /usr/local/bin<br /> * mkdir /home/mythtv/.mythicalLibrarian<br /> * Make mythicalLibrarian executable by typing the following:<br /> sudo chmod +x /usr/local/bin/mythicalLibrarian<br /> <br /> [[File:Mythicalsetthumb.jpg|right|thumb|250px| Click this link to see the big picture http://wiki.xbmc.org/images/4/4e/Mythicalsettingss.jpg]]<br /> This section covers basic setup of mythicalLibrarian. To make mythicalLibrarian work, you will need to set the following settings located in text format within mythicalLibrarian.sh.You can see a picture of the settings to the right.<br /> * MoveDir - this is your primary episode move dir.<br /> * AlternateMoveDir- this is the folder where episodes will be moved if movedir cannot be used<br /> * FailSafeDir- folder to place links if files cannot be moved<br /> * PrimaryMovieDir-Folder to place movies<br /> * AlternateMovieDir- this is where movies will be placed if PrimaryMovieDir fails<br /> * Database username and password should be mythtv/mythtv. When installing MythTV a root user and password was assigned by the user.<br /> Leave the rest as default, or enable and disable settings as desired. <br /> <br /> '''Extra settings documentation'''<br /> The SYMLINK variable specifies to mythicalLibrarian how to treat the files. There are three modes to SYMLINK. MOVE is the preferred mode. <br /> * SYMLINK=MOVE Allows XBMC to see the file and know when it has been removed from the library. When SYMLINK=MOVE and you have set up mythtv-setup to follow symlinks when deleting, MythTV's Library will function normally and XBMC will have access to all content.<br /> * SYMLINK=LINK Keeps the original MythTV file in it's place and creates a link for XBMC to read. This link is not maintained and the symlink will remain after the original file has been deleted<br /> * SYMLINK=Disabled Moves the file to the new location and does not provide a symlink to MythTV. On top of this, it will purge MythTV's database of all information and pictures relating to the video content. MythTV will have no memory of the recording. This mode can be used if you wish to delete files from XBMC.<br /> [[File:Movelink.gif|right|thumb|250 px|Represents awareness of files between MythTV and XBMC]]Movelink.gif<br /> <br /> ==== Use of mythicalLibrarian on MythTV Applications ====<br /> This section covers setup of MythTV without any changes to mythicalLibrarian settings. This will create only a basic setup. Make sure to follow up by checking the /home/mythtv/mythicalLibrarian/output.log file after the first run.<br /> <br /> * Download mythicalLibrarian.sh and put it on your desktop: http://mythicallibrarian.googlecode.com/files/mythicalLibrarian.sh<br /> * Download librarian-notify-send and put it on your desktop: http://mythicallibrarian.googlecode.com/files/librarian-notify-send<br /> * Type the following into a terminal<br /> sudo apt-get install curl agrep libnotify-bin<br /> sudo mkdir /home/mythtv /home/mythtv/mythicalLibrarian /home/mythtv/Episodes /home/mythtv/Movies /home/mythtv/Videos /home/mythtv/FailSafe<br /> sudo chown -R mythtv:mythtv /home/mythtv /home/mythtv/mythicalLibrarian /home/mythtv/Episodes /home/mythtv/Movies /home/mythtv/Videos /home/mythtv/FailSafe<br /> sudo mv ~/Desktop/mythicalLibrarian.sh /home/mythtv/mythicalLibrarian/mythicalLibrarian.sh<br /> sudo mv ~/Desktop/librarian-notify-send /usr/local/bin/librarian-notify-send<br /> sudo chmod +x /usr/local/bin/librarian-notify-send<br /> sudo chmod +x /home/mythtv/mythicalLibrarian/mythicalLibrarian.sh<br /> <br /> ===== MythTV settings =====<br /> See use of mythicalLibrarian on MythTV Applications for setting up mythtv here: http://wiki.xbmc.org/index.php?title=MythicalLibrarian&amp;action=edit&amp;section=4<br /> sudo adduser *Your User Name here* mythtv<br /> * Click System/Administration MythTV Backend setup<br /> * Select &quot;1. General&quot; then select next until you get to screen 3 <br /> * Check &quot;Follow symbolic links when deleting files&quot;. <br /> * Select next until you get to screen 8<br /> * Check &quot;Allow user job #1 Jobs&quot;<br /> * Select next until you get to screen 10<br /> UserJob #1 Description: mythicalLibrarian<br /> User Job #1 Command: /usr/local/bin/mythicalLibrarian &quot;%DIR%/%FILE%&quot;<br /> * Select Finish to exit<br /> * Select 6. Storage Directories<br /> * Select Default<br /> * Add a recording folder to which MythTV has access ie. /home/mythtv/Videos<br /> * Add additional folders if required. <br /> * Remove folders to which MythTV cannot run move jobs such as /lib or /var<br /> <br /> ==== Use of mythicalLibrarian on non-MythTV Applications ====<br /> This section covers setup of non-MythTV applications. Make sure permissions are set correctly.<br /> * edit mythicalLibrarian.sh and set Database=Disabled<br /> * Set mythicalLibrarian up to run the job as follows:<br /> /home/mythtv/mythicalLibrarian/mythicalLibrarian.sh &quot;Show name&quot; &quot;Show Title&quot; &quot;File to rename&quot;<br /> * see Setting the Settings in this section<br /> <br /> == Using the command line ==<br /> mythicalLibrarian has many command line switches. This section covers command line use of mythicalLibrarian.<br /> ===== mythicalLibrarian Normal Operation =====<br /> This section covers normal operation of mythicalLibrarian<br /> When using mythicalLibrarian to rename files individually without database access, you can run the following command. Without database access, mythicalLibrarian can only look up episodes with title and subtitle.<br /> mythicalLibrarian /home/mythtv/videos/1024_33020100321.mpg &quot;spongebob squarepants&quot; &quot;giant squidward&quot;<br /> mythicalLibrarian /path/to/video/file.ext &quot;episode title&quot; &quot;episode subtitle&quot;<br /> <br /> When using mythicalLibrarian with the mythtv database access you can run mythicalLibrarian as the following command.<br /> mythicalLibrarian /home/mythtv/videos/1024_33020100321.mpg<br /> mythicalLibrarian /path/to/mythtv/videos/filename.ext<br /> mythicalLibrarian will integrate with the mythtv database as a user job after recordings. The mythtv user job for this is:<br /> /usr/local/bin/mythicalLibrarian &quot;%DIR%/%FILE%&quot;<br /> <br /> ===== mythicalLibrarian --help =====<br /> This section covers -h|--help<br /> mythicalLibrarian --help<br /> --help will display a help message containing helpful information<br /> ===== mythicalLibrarian --scan =====<br /> This section covers -s|--scan<br /> mythicalLibrarian --scan mpg /home/mythtv/Videos<br /> mythicalLibrarian --scan ext /path/to/video/files<br /> --scan will search for files automatically and process them. <br /> --scan has two parmaters. The first parameter is the extension of the files to search. The seccond parameter is the folder to search.<br /> <br /> ===== mythicalLibrarian --doover =====<br /> This section covers -d|--doover<br /> mythicalLibrarian --doover <br /> mythicalLibrarian keeps track of each file which fails while it runs. At any time you can type &quot;mythicalLibrarian --doover&quot; and all previously failed files will be processed. This process cannot be interrupted for any reason or data loss may occour.<br /> ===== mythicalLibrarian --undo =====<br /> This section covers -u|--undo<br /> mythicalLibrarian --undo<br /> mythicalLibrarian keeps track of every file which has been moved. At any time you can type mythicalLibrarian --undo and all files will be reverted to their original state. There is no indication that --doover is running until it completes. This process cannot be interrupted or data loss may occour.<br /> ===== mythicalLibrarian --update =====<br /> This section covers --update<br /> sudo mythicalLibrarian --update<br /> --update is a complicated process. First, mythicalLibrarian will download a copy of the mythicalSetup from the SVN repository. Next, it will download a copy of mythicalLibrarian from the SVN repository. mythicalSetup will then separate the program from the user settings. mythicalSetup perform several checks and bring up a GUI. The GUI will ask the user for preferences. mythicalSetup will attempt to set permissions and settings to appropriate defaults based upon user settings and the system. mythicalSetup will then combine the user settings with the separated program and place the file in /usr/local/bin. mythicalSetup will then call mythicalLibrarian --mythicalDiagnostics, which checks out your system. mythicalDiagnostics then calls mythcalLibrarian testfile.ext &quot;mister&quot; &quot;episode 1332&quot;, which puts mythicalLibrarian into a diagnostic run. Once complete, the mythicalLibrarian in test mode, mythicalDiagnostics, mythicalSetup and update are closed and results are returned to the user.<br /> <br /> '''Note:''' it is always a good idea to run mythicalLibrarian --doMaintenance after an update.<br /> <br /> ===== mythicalLibrarian --mythicalDiagnostics =====<br /> This section covers -m|--mythicalDiagnostics<br /> mythicalLibrarian --mythicalDiagnostics<br /> --mythicalDiagnostics is a step-by-step functions check of mythicalLibrarian which will test functionality. It tests for all '''known''' causes of failure. This is a good troubleshooting tool for you to work the kinks out of your settings. mythicalLibrarian runs a series of diagnostics and then runs a search for an episode of mr rodgers with the file name set to testfile.ext. testfile.ext truncates the execution of mythicalLibrarian before any file operations occur. mythicalDiagnostics will return results which should look like this <br /> All tests complete RESULTS<br /> Installed Packages: ***PASSED*** <br /> Notifications Test: ***PASSED***<br /> XBMC Communications: ***PASSED***<br /> File System Checks: ***PASSED***<br /> mythicalTesting: ***PASSED***<br /> Overall mythicalReadiness: ***PASSED***<br /> -----End of diagnostics-----<br /> Notifications test and xbmc communications test will not fail overall mythicalReadiness. Only critical checks effect overall mythicalReadiness. Critical checks are dependencies, file system, and mythicalTesting.<br /> <br /> == User Jobs ==<br /> mythicalLibrarian allows flexibility in it's programming through the use of [[MythicalLibrarian UserJobs]]. <br /> <br /> ==== Benefeits of user jobs ====<br /> User Jobs are supported to allow for your individual custom set-up to be personalized. You can rename files, and set custom commands to be run after execution of mythicalLibrarian. By using [[MythicalLibrarian UserJobs]] in mythicalLibrarian you can upgrade without loosing the work you have put into it.<br /> <br /> Please post in the forums about any user jobs you have come up with. They will be of use to others. http://forum.xbmc.org/showthread.php?t=65644<br /> <br /> == Librarian Interfaces ==<br /> mythicalLibrarian has the capability to send notifications to lib-notify on the DBUS of a Linux computer and keep your XBMC library up-to-date and clean. This section covers setup of notifications of the various platforms supported by mythicalLibrarian<br /> <br /> ==== XBMC Commands ====<br /> [[File:Xbmc notification.jpg|right|http://www.xbmc.org Another Sucessful library addition]]<br /> This section covers setup of XBMC Commands. mythicalLibrarain can keep XBMC's library up to date, clean out deleted files and send a notification upon a completed job. <br /> * edit mythicalLibrarian.sh in your text editor<br /> * set XBMCUpdate, XBMCClean, and XBMCNotify to the desired settings, either Enabled, or Disabled<br /> * Set the IP and port under XBMCIPs. Separate IP addresses with a space. eg.<br /> XBMCIPs=( &quot;192.168.1.110:8080 192.168.1.111:8080 XBOX:8080&quot; )<br /> <br /> ==== GNOME Desktop Notifications ====<br /> [[File:GNOMENotificationsthumbs.jpg|right|thumb|250px|Another Sucessful library addition ]]<br /> * mythicalLibrarian requires no-password sudo access to send GNOME notifications.<br /> <br /> Desktop notifications can be turned on and off from within the script settings. Desktop notifications take advantage of the lib-notify DBUS feature. DBUS is only supported on Linux.<br /> <br /> Desktop notifications are used on the back-end machine by mythicalLibrarian to let you know that a file move operation is in process or an operation has completed. The external script librarian-notify-send becomes the specified username and sends a GNOME desktop notification. librarian-notify-send requires the user mythtv to have access to the sudo command without a password if run as a user job. <br /> <br /> * Get the current version of librarian-notify-send from Google Code [http://mythicallibrarian.googlecode.com/files/librarian-notify-send download link]<br /> * place the file in /usr/local/bin<br /> * add mythtvall group<br /> sudo addgroup mythtvall<br /> * add mythtv to the mythtvall group<br /> sudo adduser mythtv mythtvall<br /> * edit the sudoers file<br /> sudo visudo<br /> * add the following line to the sudoers<br /> %mythtvall ALL=(ALL) NOPASSWD:ALL<br /> * hit ctrl-x and then y, then enter to write out and quit visudo<br /> * make librarian-notify-send executable by typing<br /> sudo chmod +x /usr/local/bin/librarian-notify-send<br /> * edit mythicalLibrarian and set Notify=Enabled and NotifyUserName=*your user name*<br /> <br /> You are done.<br /> <br /> <br /> == Troubleshooting ==<br /> While mythicalLibrarian is designed to run fully autonomously, configuration issues come up from time to time. This section deals with these set-up issues<br /> <br /> <br /> === '''Random Errors''' ===<br /> This section of Troubleshooting is designated for random errors which make no sense. These include errors which make you think mythicalLibrarian simply does not work.<br /> <br /> ==== Dependencies ====<br /> This section covers dependencies of mythicalLibrarian. Usually you can find dependencies by typing &quot;command -V&quot; or &quot;command --version&quot;<br /> * The following are the versions of the binaries which mythicalLibrarian depends upon and are not in OS Karmic Koala.<br /> agrep -V This is agrep version 3.0, 1994.<br /> curl 7.19.5 (i486-pc-linux-gnu) libcurl/7.19.5 OpenSSL/0.9.8g zlib/1.2.3.3 libidn/1.15<br /> dialog Version: 1.1-20080819<br /> mysql Ver 14.14 Distrib 5.1.37, for debian-linux-gnu (i486) using EditLine wrapper<br /> notify-send 0.4.5<br /> python2.6<br /> * The Following are the versions of the binaries which mythicalLibrarian depends upon and are included in OS Karmic Koala.<br /> bash GNU bash, version 4.0.33(1)-release (i486-pc-linux-gnu)<br /> (GNU coreutils) 7.4<br /> sed GNU sed version 4.2.1<br /> grep GNU grep 2.5.4<br /> awk GNU Awk 3.1.6<br /> ifconfig 1.42 (2001-04-13) net-tools 1.60<br /> replace Ver 1.4 for debian-linux-gnu at i486<br /> <br /> === '''Permission Errors''' ===<br /> This section of Troubleshooting is designated for permission errors.<br /> ==== permission errors when run from terminal ====<br /> Ensure the user running mythicalLibrarian has permission to run mythicalLibrarian. This includes read and write permissions to the working folder (default=~/mythicalLibrarian) <br /> see this post for more information: http://forum.xbmc.org/showpost.php?p=489246&amp;postcount=36<br /> ==== mythicalLibrarian is not generating a log ====<br /> Make sure mythicalLibrarian.sh is executable. You can set the permissions by typing &quot;sudo chmod +x /path/to/mythicalLibrarian.sh&quot;<br /> note: mythtv will be the user running mythicalLibrarian when run as a user job from MythTV<br /> see this post for more information: http://forum.xbmc.org/showpost.php?p=489246&amp;postcount=36<br /> <br /> remember, the user who launched mythtv-backend has to have permissions. You can check this manually by using the following:<br /> sudo su *user who launched mythtv-backend*<br /> mythicalLibrarian --mythicalDiagnostics<br /> where *user who launched mythtv-backend* is the username of the user who launched mythtv-backend<br /> <br /> ==== Files are not being renamed or moved, but they are owned my mythtv ====<br /> mythtv must have full access to the files. the /var/ folder does not allow users to move files without special permissions. Try moving your recording directory to your /home/ folder<br /> ==== mythicalLibrarian works from terminal, but not from user job ====<br /> &quot;mythtv&quot; is the user calling the user job. If the user running mythicalLibrarian does not have access to the file, then mythicalLibrarian will not have access to the file. MythTV users can troubleshoot by changing your username with &quot;sudo su mythtv&quot;, then running mythicalLibrarian. <br /> ==== mythcialLibrarian will not copy to my NFTF/FAT/EXT3 mounted drive ====<br /> Additonal file systems may require editing the /etc/fstab file to change permissions. Search your OS documentation for information on how to mount a file system under a different username. Alternately, you may wish to add the user running mythicalLibrarian to your user group.<br /> <br /> <br /> === '''XBMC library is not updated''' ===<br /> This section of Troubleshooting is designated for XBMC specific issues<br /> ==== XBMC does not show notifications ====<br /> mythicalLibrarian requires the user to set the IP address of XBMC within mythicalLibrarian.sh<br /> * ensure you have a static IP set up in your router, see your router's manufacturer's website for more information<br /> * Open mythicalLibrarian.sh and edit the &quot;XBMCIPs&quot; setting to your XBMC IP.<br /> ==== XBMC shows notifications but Library is not updated ====<br /> * Add a source http://wiki.xbmc.org/?title=Adding_Media_Sources<br /> * Set the content of your video library http://wiki.xbmc.org/?title=Set_Contents_%28Video_Library%29<br /> <br /> <br /> <br /> === '''OS Speciffic issues''' ===<br /> This section of Troubleshooting is designated for OS Specific issues<br /> ==== Gentoo ====<br /> Gentoo OS requires upgrade of many packages. For sure you will need the package TRE. See here for version information: http://forum.xbmc.org/showpost.php?p=495697&amp;postcount=62<br /> === Arch Linux ===<br /> Arch Linux utilizes Python3 for it's primary Python interperater. Python 2.6 is used for MythDataGrabber(the program responsible for grabbing information from the MythTV database). You will need to install Python2.6<br /> wget http://aur.archlinux.org/packages/python26/python26.tar.gz &amp;&amp; tar xvf python26.tar.gz<br /> cd python26 &amp;&amp; makepkg -s<br /> pacman -U python26-2.6.5-1-i686.pkg.tar.gz<br /> After installing Python2.6, the MythDataGrabber shebang needs to be modified to specify the Python2.6 interperater. The first line in /usr/local/bin/MythDataGrabber should read<br /> #! /usr/bin/python2.6<br /> see here for more information http://forum.xbmc.org/showpost.php?p=689145&amp;postcount=714<br /> <br /> ==== Mac OS X ====<br /> If mythtv-backend is launched by a different user then yourself, then you will need to set permissions for that user. See here for more information: http://osxdaily.com/2007/10/29/how-to-add-a-user-from-the-os-x-command-line-works-with-leopard/<br /> <br /> === '''Problems after upgrade to new version''' ===<br /> This section of Troubleshooting is designated for issues after upgrade when the previous version was working<br /> ==== Episodes are not identifed ====<br /> When episodes are not identified after an upgrade it is because the database handling has been upgraded, however, the database itself has not. Delete all database folders to correct the issue http://forum.xbmc.org/showpost.php?p=492001&amp;postcount=40<br /> ==== mythicalLibrarian does not generate any files in it's working directory ====<br /> Ensure the user running mythicalLibrarian has permission to run mythicalLibrarian. This includes read and write permissions to the working folder (default=~/mythicalLibrarian)<br /> <br /> <br /> === '''Episode recognition problems''' ===<br /> ==== Series title is not properly recognized ====<br /> TheTvDb.com does not have the proper Zap2it id included. Edit it. <br /> The program guide uses a generic name. Apply a showtranslation. See documentation included within mythicalLibrarian.sh.<br /> === Episode title was not properly recognized ===<br /> TheTvDb.com is down. Wait for TheTvDb.com to resume and then run the doover.sh file generated by mythicalLibrarian<br /> Ensure the data at TheTvDb is accurate. Correct if needed.<br /> <br /> <br /> === ''' Desktop Notifications''' ===<br /> This section of Troubleshooting is designated for GNOME Desktop Notifications issues<br /> ==== Desktop Notifications are not showing up ====<br /> Ensure you have Notify=Enabled set in mythicalLibrarian.sh See this section for more information http://wiki.xbmc.org/index.php?title=MythicalLibrarian&amp;action=submit#GNOME_Desktop_Notifications<br /> <br /> <br /> === Guide Data errors ===<br /> for SchedulesDirect/Tribune/Zap2it set the GuideDataType setting in mythicalLibrarian.sh to &quot;SchedulesDirect&quot;<br /> ==== Currently Unsupported Guide data types ====<br /> Support for guide data will be available with help from you. See this post: http://forum.xbmc.org/showpost.php?p=496721&amp;postcount=90<br /> <br /> <br /> === Upgrade Issues ===<br /> This section deals with issues relating to upgrading mythicalLibrarian<br /> <br /> when upgrading mythicalLibrarian there may be random errors. When upgrading after more then a month it is a good idea to run <br /> mythicalLibrarian --doMaintenance<br /> When running do maintenance, you should ensure that all of your removable drives are attached. doMaintenance will flush the cache and mythicalLibrarian's internal database.<br /> <br /> === Misc ===<br /> This section provides miscellanious fixes for user issues.<br /> <br /> ==== mythicalFileRestoration ====<br /> When running in Symlink=Disabled mode, mythicalLibrarian deletes database information. In older versions of mythicalLibrarian all files were logged in the undo and doover que. When running in doover or undo mode, the files are first reverted to the original state and then reprocessed later. Because there is no database information, they cannot be reprocessed. However, all hope is not lost. The logs contain valuable information and [http://twitter.com/szczys Mike Szczys] wrote a small Python application which will review these logs and restore the files.<br /> <br /> '''NOTE:''' The script does check to make sure it's not overwriting existing files. However, it doesn't creat directories. You must manually create any subdirectories that don't already exist or the files will not be moved.<br /> <br /> file:/usr/local/bin/mythicalFileRestoration<br /> #! /usr/bin/python2.6<br /> import os<br /> myfile = &quot;~/.mythicalLibrarian/undo.sh.old&quot;<br /> f = open(myfile,'r')<br /> for line in f:<br /> if line.startswith('test -f'):<br /> file1 = line.split(' &amp;&amp; ')[0]<br /> file1 = file1.replace('test -f ','')<br /> file2 = line.split(' &amp;&amp; ')[1].split(' ')[-1]<br /> if os.path.isfile(file2[1:-1]):<br /> if not os.path.isfile(file1[1:-1]):<br /> cmdLine = 'mv ' + file2 + ' ' + file1<br /> print cmdLine<br /> # uncomment the next line to activate the script <br /> # print os.system(cmdLine)<br /> Run this file first and view the output, if it works properly, uncomment the last line to activate it.<br /> <br /> == Notes ==<br /> mythicalLibrarian is a spawn from the project BashSExx and [[MythSExx]]. <br /> <br /> [[MythSExx]] and BashSExx have been depreciated.<br /> <br /> [[Category:Linux]]<br /> [[Category:Mac OS X]]<br /> [[Category:Supplemental tools]]<br /> [[Category:Live TV]]</div>

Schapplm https://kodi.wiki/index.php?title=Archive:Debug_Python_Scripts_with_Eclipse&diff=78143 2014-08-24T18:28:18Z

<p>Schapplm: /* Add Pyhton Interpreter Path */</p> <hr /> <div>{{mininav|[[Development]]|[[Add-on development]]|[[Python development]]}}<br /> <br /> Here is a method you can adopt in order to use the Eclipse (multi-platforms) remote debugger with your Python scripts/plugin.<br /> <br /> Note: Follow this link [[HOW-TO debug Python Scripts|Debugging Python Scripts on Linux with WinPDB]] for more information if you prefer to use WinPDB instead.<br /> <br /> Note: The information provided herein is also applicable to user with [http://www.aptana.com/ Aptana Studio 3] installation which come pre-installed with pydev. For this case, you can skip to [[#Configure Pydev and Eclipse|Configure Pydev and Eclipse]] after the Aptana Studio 3 installation.<br /> <br /> <br /> <br /> == Prerequisite ==<br /> * Any platform able to run [http://www.eclipse.org/downloads/ Eclipse IDE] (Windows 32bit-64bit, Mac Carbon 32bit-64bit, Mac Cocoa 32bit-64bit, Linux 32bit-64bit): it is the platform from where you will run the debugger IDE<br /> * Python interpreter 2.4 (use the same version as XBMC or version &lt;= 2.7 ) install on the machine running Eclipse<br /> * Any platform running XBMC (Xbox, Linux, MACOSX, Windows): it is the platform running Python scripts/plugin connecting with the remote debugger.<br /> :XBMC installed on Ubuntu (should work just fine on Windows and Mac too)<br /> * [http://pydev.org/ Pydev] plugin for Eclipse IDE: Pydev is a Python IDE for Eclipse, which may be used in Python, Jython and IronPython development.<br /> <br /> == Prepare and Setup Eclipse ==<br /> <br /> === Install Eclipse ===<br /> * Download [http://www.eclipse.org/downloads/ Eclipse IDE] and install it<br /> Note: in our example Eclipse Galileo (3.5.1) is used<br /> <br /> <br /> <br /> === Install Pydev in Eclipse ===<br /> * In Eclipse go in: ''Help'' -&gt; ''Install New Software...''<br /> * Click on the ''Add'' button and add Pydev website as a source: http://pydev.org/updates<br /> * You will see the window below:<br /> [[File:EclipsePydevUpdate.png]]<br /> * Check ''PyDev'' box and follow the steps in order to install PyDev<br /> Note: in our example PyDev 1.5.5<br /> <br /> <br /> <br /> === Configure Pydev and Eclipse ===<br /> <br /> <br /> ==== Add Python Interpreter Path ====<br /> * Go in ''Window'' -&gt; ''Preferences''<br /> * ''Pydev'' then ''Interpreter - Python''<br /> * Click on button ''New...''<br /> * In the new prompt, enter the ''Interpreter Name: Python'', and Browse for your Python Interpreter 2.4 ''python.exe'' file and select it. After that you should see something like this:<br /> [[File:EclipsePydevPref.png|none]]<br /> This will help in order to have Python code completion (except for XBMC modules)<br /> <br /> ==== Add Pydev view to Eclipse ====<br /> * On the top right corner click on the View button on select ''Others''<br /> [[File:EclipsePydevViewMenu.png]]<br /> * Select Pydev then OK, a PyDev View Button should be now available on the top right corner<br /> [[File:EclipsePydevViewMenu2.png]]<br /> Use this view for your developments in Python for XBMC<br /> <br /> <br /> ==== Add Pydev Start/Stop debug server buttons ====<br /> * In the menu bar select ''Window'' -&gt; ''Customize perspective...'', a window ''Customize Perspective - PyDev'' will open<br /> * Select ''Command Groups Availability'' Tab<br /> * Check ''Pydev Debug'' box and OK<br /> * You should see 2 new buttons in your toolbar:<br /> [[File:EclipsePydevDebugSrvButtons.png]]<br /> <br /> <br /> ==== Setting the remote debugger port (optional) ====<br /> If you do not want to use the default port (usually 5678) you can set it up:<br /> * Go to ''Window'' -&gt; ''Preferences''<br /> * ''Pydev'' then ''Debug'' you can define here the port and the timeout you want<br /> <br /> ==== Setting up Predefined Completions (optional) ====<br /> Many developers are accustom to using predefined completions when writing their code (eg. type-ahead). The standard Python completions are enabled by default when using these instructions, but the standard XBMC components will not be recognized appropriately (xbmc, xbmcgui, xbmcplugin, etc). <br /> <br /> In order to overcome this, you can run the [http://forum.xbmc.org/showthread.php?t=79070 PyDev Predefined Completions Creator addon] and [http://pydev.org/manual_101_interpreter.html#PyDevInterpreterConfiguration-PredefinedCompletions setup Eclipse] to reference this file:<br /> # Download the 'PyDev Predefined Completions Creator' Addon (eg. System &gt; Settings &gt; Addons &gt; XBMC.org &gt; Program Add-Ons)<br /> # Navigate to the newly installed Addon (eg. Programs from the home screen)<br /> # Open the context menu for newly installed addon and select 'Add-on Settings'<br /> # Set the location to save the help docs to and save the new settings (This can be anywhere on your system - we'll configure it in Eclipse later)<br /> # Select the add-on to run it (the addon should run and close quickly)<br /> # Open Eclipse and select Window &gt; Preferences &gt; PyDev &gt; Interpreter - Python<br /> # From the 'Predefined' tab, click the new button and select the folder you created in the step above<br /> # Press Apply / OK to ensure the changes are saved<br /> <br /> == Create a Python script/plugin for XBMC in Eclipse ==<br /> <br /> <br /> === Create a new PyDev Project ===<br /> Most of the time when you are doing development, likely that you are running XBMC and Eclipse on the same platform; (The installed debugger described in this article actually can also work with a remote XBMC).&lt;br\&gt;<br /> Let's say you already have scripts installed in XBMC script folder that you want to create a new PyDev project e.g.<br /> &lt;pre&gt;<br /> C:\XBMC\addons\myscript1<br /> C:\XBMC\addons\myscript2<br /> &lt;/pre&gt;<br /> <br /> With myscript1 &amp; myscript2 being sub-directories of ''C:\XBMC\addons'' each containing the Default.py scripts.&lt;br\&gt;<br /> First you need to define the Python project workspace:<br /> * ''File'' -&gt; ''Switch Workspace'' -&gt; ''Other...''<br /> * ''Browse'' to the parent directory of your script module i.e. ''C:\XBMC\addons'' in this example, select and OK<br /> Then proceed to create the Python project:<br /> * ''File'' -&gt; ''New'' -&gt; ''PyDev Project''<br /> : OR select below in case ''PyDev Project'' is not displayed<br /> * ''File'' -&gt; ''New'' -&gt; ''Others''; and Select ''Pydev'' then ''PyDev Project''; Click ''Next''<br /> * Enter the name of your project e.g. xbmc_addons<br /> * Uncheck option ''Use Default''<br /> * Browse to the directory of your scripts and select i.e. C:\XBMC\addons.<br /> * Set ''Python' as Project Type<br /> * Select ''2.4 (XBMC Python version)'' for the grammar<br /> * Select ''Don't configure PYTHONPATH (to be done manually later on)''<br /> * Click on ''Finish'' button<br /> <br /> <br /> === Set the Python Path ===<br /> * Right click on your new project and select ''Properties''<br /> * Select ''PyDev - PYTHONPATH'' and click on ''Add source folder''<br /> * Select the source directory of your script, /xbmc_addons in our example<br /> <br /> <br /> === Import File System ===<br /> Assuming you want to add in all the directories under C:\XBMC\addons<br /> * Right click on your new project and select ''Import...''<br /> * Select ''General'' and click on ''File System''; then ''Next''<br /> * Browse to the source directory of your script (or plugin) e.g. C:\XBMC\addons<br /> * Check the directory and files to be added<br /> * Select ''Into folder: xbmc_addons''<br /> * Select ''Options | &lt;&lt;Advanced | Create links in workspace''<br /> * Uncheck both the options i.e. ''Create virtual folders'' &amp; ''Create link locations relative to;...''<br /> * Click on ''Finish'' button<br /> Your source code is now recognized by Eclipse and you will have access to neat functionality such as code completion, link between source files, etc.<br /> <br /> <br /> === Add Pydev Python source code (pysrc) to XBMC ===<br /> XBMC needs to know where to find the PyDev remote python source file in order to communicate with the remote debugger of Eclipse.<br /> <br /> ==== Identify where PyDev remote debugger Python files are ====<br /> Python source files should be in you Eclipse installation directory:<br /> &lt;pre&gt;C:\...\eclipse\plugins\org.python.pydev.debug_1.5.5.2010030420\pysrc\&lt;/pre&gt;<br /> In our case we use PyDev 1.5.5. With newer versions of PyDev, the directory structure changed.<br /> &lt;pre&gt;C:\...\eclipse\plugins\org.python.pydev_3.6.0.201406232321\pysrc\&lt;/pre&gt;<br /> Look for org.python.pydev.debug (not core)<br /> <br /> ==== Modify PyDev source in order to support XBMC paths ====<br /> The pysrc code that came with Eclipse-pydev does not support XBMC paths (special://... or Q:/...) and the module would not find them making it impossible to insert breakpoints in such files.<br /> <br /> In order to add the support of XBMC paths, you will need to do a simple modification to the file ''pydevd_file_utils.py'' consisting on adding a line to each procedure that had a filename parameter (4 procedures in total). <br /> Add a line like<br /> <br /> <br /> def _NormFile(filename):<br /> filename = xbmc.translatePath(filename)<br /> try:<br /> ...<br /> <br /> The other three procedures are:<br /> * def _NormFile(filename):<br /> * def NormFileToServer(filename):<br /> * def NormFileToClient(filename):<br /> <br /> of course you need the import directive at the top of the file:<br /> <br /> import xbmc<br /> <br /> at the beginning of the module...<br /> <br /> ==== Choose how XBMC will refer to Pydev debugging module ====<br /> <br /> You have 3 options as below:<br /> * Option 1 - Refer from our python script directly the directory where pysrc is installed<br /> * Option 2 - Copy pysrc in our script directory and refer it from our script<br /> * Option 3 - Copy pysrc in XBMC Python install<br /> <br /> I am only going to show you the steps for ''Option 3'':<br /> <br /> ==== Copy pysrc in XBMC Python install ====<br /> * Copy the content of pysrc to:<br /> &lt;pre&gt;XBMC\system\python\Lib\pysrc\&lt;/pre&gt;<br /> * Add an empty __init__.py file in it<br /> <br /> === Add to your python script the code for remote debug ===<br /> At the beginning of you Python script/plugin (usually Default.py) add the following code:<br /> &lt;pre&gt;<br /> REMOTE_DBG = True <br /> <br /> # append pydev remote debugger<br /> if REMOTE_DBG:<br /> # Make pydev debugger works for auto reload.<br /> # Note pydevd module need to be copied in XBMC\system\python\Lib\pysrc<br /> try:<br /> import pysrc.pydevd as pydevd<br /> # stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console<br /> pydevd.settrace('localhost', stdoutToServer=True, stderrToServer=True)<br /> except ImportError:<br /> sys.stderr.write(&quot;Error: &quot; +<br /> &quot;You must add org.python.pydev.debug.pysrc to your PYTHONPATH.&quot;)<br /> sys.exit(1)<br /> &lt;/pre&gt;<br /> <br /> In the case you have change the default port you can replace the line with pydevd.settrace by this one:<br /> &lt;pre&gt;<br /> pydevd.settrace('localhost', port=5678, stdoutToServer=True, stderrToServer=True)<br /> &lt;/pre&gt;<br /> <br /> * Use REMOTE_DBG in order to activate or not the remote debugging<br /> * port specifies the listening port number use between the client and the server<br /> * Replace localhost by an IP address if XBMC and Eclipse are on 2 different machines<br /> * stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console, you won't have to open xbmc.log file<br /> <br /> <br /> <br /> === Run ===<br /> * Go in Debug view (Eclipse: [[File:changeperspective.png]] / Debug ) and press on the start server button: [[File:EclipsePydevDebugSrvButtons.png]]<br /> <br /> * You will see in the console logs like:<br /> &lt;pre&gt;Debug Server at port: 5678&lt;/pre&gt;<br /> <br /> * Start XBMC and run your script/plugin, you will see it as &quot;Running&quot; but paused<br /> <br /> * In Eclipse (Debug View) click on the Resume button (or F8), then you will see the program running in XBMC<br /> <br /> * You are now fully set up: You can set break-point, watch on variables, run step by step etc<br /> <br /> * Enjoy!<br /> <br /> === Screenshot ===<br /> <br /> [[File:EclipsePydevDebugger.png]]<br /> <br /> ==See also==<br /> * [[Add-ons]]<br /> * [[:Category:All add-ons]]<br /> * [[3rd party add-on repositories]]<br /> '''Development:'''<br /> * [[Add-on development]]<br /> * [[Addon Settings]]<br /> * [[Python development]]<br /> * [[Add-on repositories]]<br /> * [[Official add-on repository]]<br /> <br /> [[Category:Python]]<br /> [[Category:How-to]]<br /> [[Category:Add-on development]]</div>

Schapplm https://kodi.wiki/index.php?title=Archive:Debug_Python_Scripts_with_Eclipse&diff=78140 2014-08-24T17:53:08Z

<p>Schapplm: /* Prerequisite */</p> <hr /> <div>{{mininav|[[Development]]|[[Add-on development]]|[[Python development]]}}<br /> <br /> Here is a method you can adopt in order to use the Eclipse (multi-platforms) remote debugger with your Python scripts/plugin.<br /> <br /> Note: Follow this link [[HOW-TO debug Python Scripts|Debugging Python Scripts on Linux with WinPDB]] for more information if you prefer to use WinPDB instead.<br /> <br /> Note: The information provided herein is also applicable to user with [http://www.aptana.com/ Aptana Studio 3] installation which come pre-installed with pydev. For this case, you can skip to [[#Configure Pydev and Eclipse|Configure Pydev and Eclipse]] after the Aptana Studio 3 installation.<br /> <br /> <br /> <br /> == Prerequisite ==<br /> * Any platform able to run [http://www.eclipse.org/downloads/ Eclipse IDE] (Windows 32bit-64bit, Mac Carbon 32bit-64bit, Mac Cocoa 32bit-64bit, Linux 32bit-64bit): it is the platform from where you will run the debugger IDE<br /> * Python interpreter 2.4 (use the same version as XBMC or version &lt;= 2.7 ) install on the machine running Eclipse<br /> * Any platform running XBMC (Xbox, Linux, MACOSX, Windows): it is the platform running Python scripts/plugin connecting with the remote debugger.<br /> :XBMC installed on Ubuntu (should work just fine on Windows and Mac too)<br /> * [http://pydev.org/ Pydev] plugin for Eclipse IDE: Pydev is a Python IDE for Eclipse, which may be used in Python, Jython and IronPython development.<br /> <br /> == Prepare and Setup Eclipse ==<br /> <br /> === Install Eclipse ===<br /> * Download [http://www.eclipse.org/downloads/ Eclipse IDE] and install it<br /> Note: in our example Eclipse Galileo (3.5.1) is used<br /> <br /> <br /> <br /> === Install Pydev in Eclipse ===<br /> * In Eclipse go in: ''Help'' -&gt; ''Install New Software...''<br /> * Click on the ''Add'' button and add Pydev website as a source: http://pydev.org/updates<br /> * You will see the window below:<br /> [[File:EclipsePydevUpdate.png]]<br /> * Check ''PyDev'' box and follow the steps in order to install PyDev<br /> Note: in our example PyDev 1.5.5<br /> <br /> <br /> <br /> === Configure Pydev and Eclipse ===<br /> <br /> <br /> ==== Add Pyhton Interpreter Path ====<br /> * Go in ''Window'' -&gt; ''Preferences''<br /> * ''Pydev'' then ''Interpreter - Python''<br /> * Click on button ''New...''<br /> * In the new prompt, enter the ''Interpreter Name: Python'', and Browse for your Python Interpreter 2.4 ''python.exe'' file and select it. After that you should see something like this:<br /> [[File:EclipsePydevPref.png|none]]<br /> This will help in order to have Python code completion (except for XBMC modules)<br /> <br /> <br /> ==== Add Pydev view to Eclipse ====<br /> * On the top right corner click on the View button on select ''Others''<br /> [[File:EclipsePydevViewMenu.png]]<br /> * Select Pydev then OK, a PyDev View Button should be now available on the top right corner<br /> [[File:EclipsePydevViewMenu2.png]]<br /> Use this view for your developments in Python for XBMC<br /> <br /> <br /> ==== Add Pydev Start/Stop debug server buttons ====<br /> * In the menu bar select ''Window'' -&gt; ''Customize perspective...'', a window ''Customize Perspective - PyDev'' will open<br /> * Select ''Command Groups Availability'' Tab<br /> * Check ''Pydev Debug'' box and OK<br /> * You should see 2 new buttons in your toolbar:<br /> [[File:EclipsePydevDebugSrvButtons.png]]<br /> <br /> <br /> ==== Setting the remote debugger port (optional) ====<br /> If you do not want to use the default port (usually 5678) you can set it up:<br /> * Go to ''Window'' -&gt; ''Preferences''<br /> * ''Pydev'' then ''Debug'' you can define here the port and the timeout you want<br /> <br /> ==== Setting up Predefined Completions (optional) ====<br /> Many developers are accustom to using predefined completions when writing their code (eg. type-ahead). The standard Python completions are enabled by default when using these instructions, but the standard XBMC components will not be recognized appropriately (xbmc, xbmcgui, xbmcplugin, etc). <br /> <br /> In order to overcome this, you can run the [http://forum.xbmc.org/showthread.php?t=79070 PyDev Predefined Completions Creator addon] and [http://pydev.org/manual_101_interpreter.html#PyDevInterpreterConfiguration-PredefinedCompletions setup Eclipse] to reference this file:<br /> # Download the 'PyDev Predefined Completions Creator' Addon (eg. System &gt; Settings &gt; Addons &gt; XBMC.org &gt; Program Add-Ons)<br /> # Navigate to the newly installed Addon (eg. Programs from the home screen)<br /> # Open the context menu for newly installed addon and select 'Add-on Settings'<br /> # Set the location to save the help docs to and save the new settings (This can be anywhere on your system - we'll configure it in Eclipse later)<br /> # Select the add-on to run it (the addon should run and close quickly)<br /> # Open Eclipse and select Window &gt; Preferences &gt; PyDev &gt; Interpreter - Python<br /> # From the 'Predefined' tab, click the new button and select the folder you created in the step above<br /> # Press Apply / OK to ensure the changes are saved<br /> <br /> == Create a Python script/plugin for XBMC in Eclipse ==<br /> <br /> <br /> === Create a new PyDev Project ===<br /> Most of the time when you are doing development, likely that you are running XBMC and Eclipse on the same platform; (The installed debugger described in this article actually can also work with a remote XBMC).&lt;br\&gt;<br /> Let's say you already have scripts installed in XBMC script folder that you want to create a new PyDev project e.g.<br /> &lt;pre&gt;<br /> C:\XBMC\addons\myscript1<br /> C:\XBMC\addons\myscript2<br /> &lt;/pre&gt;<br /> <br /> With myscript1 &amp; myscript2 being sub-directories of ''C:\XBMC\addons'' each containing the Default.py scripts.&lt;br\&gt;<br /> First you need to define the Python project workspace:<br /> * ''File'' -&gt; ''Switch Workspace'' -&gt; ''Other...''<br /> * ''Browse'' to the parent directory of your script module i.e. ''C:\XBMC\addons'' in this example, select and OK<br /> Then proceed to create the Python project:<br /> * ''File'' -&gt; ''New'' -&gt; ''PyDev Project''<br /> : OR select below in case ''PyDev Project'' is not displayed<br /> * ''File'' -&gt; ''New'' -&gt; ''Others''; and Select ''Pydev'' then ''PyDev Project''; Click ''Next''<br /> * Enter the name of your project e.g. xbmc_addons<br /> * Uncheck option ''Use Default''<br /> * Browse to the directory of your scripts and select i.e. C:\XBMC\addons.<br /> * Set ''Python' as Project Type<br /> * Select ''2.4 (XBMC Python version)'' for the grammar<br /> * Select ''Don't configure PYTHONPATH (to be done manually later on)''<br /> * Click on ''Finish'' button<br /> <br /> <br /> === Set the Python Path ===<br /> * Right click on your new project and select ''Properties''<br /> * Select ''PyDev - PYTHONPATH'' and click on ''Add source folder''<br /> * Select the source directory of your script, /xbmc_addons in our example<br /> <br /> <br /> === Import File System ===<br /> Assuming you want to add in all the directories under C:\XBMC\addons<br /> * Right click on your new project and select ''Import...''<br /> * Select ''General'' and click on ''File System''; then ''Next''<br /> * Browse to the source directory of your script (or plugin) e.g. C:\XBMC\addons<br /> * Check the directory and files to be added<br /> * Select ''Into folder: xbmc_addons''<br /> * Select ''Options | &lt;&lt;Advanced | Create links in workspace''<br /> * Uncheck both the options i.e. ''Create virtual folders'' &amp; ''Create link locations relative to;...''<br /> * Click on ''Finish'' button<br /> Your source code is now recognized by Eclipse and you will have access to neat functionality such as code completion, link between source files, etc.<br /> <br /> <br /> === Add Pydev Python source code (pysrc) to XBMC ===<br /> XBMC needs to know where to find the PyDev remote python source file in order to communicate with the remote debugger of Eclipse.<br /> <br /> ==== Identify where PyDev remote debugger Python files are ====<br /> Python source files should be in you Eclipse installation directory:<br /> &lt;pre&gt;C:\...\eclipse\plugins\org.python.pydev.debug_1.5.5.2010030420\pysrc\&lt;/pre&gt;<br /> In our case we use PyDev 1.5.5. With newer versions of PyDev, the directory structure changed.<br /> &lt;pre&gt;C:\...\eclipse\plugins\org.python.pydev_3.6.0.201406232321\pysrc\&lt;/pre&gt;<br /> Look for org.python.pydev.debug (not core)<br /> <br /> ==== Modify PyDev source in order to support XBMC paths ====<br /> The pysrc code that came with Eclipse-pydev does not support XBMC paths (special://... or Q:/...) and the module would not find them making it impossible to insert breakpoints in such files.<br /> <br /> In order to add the support of XBMC paths, you will need to do a simple modification to the file ''pydevd_file_utils.py'' consisting on adding a line to each procedure that had a filename parameter (4 procedures in total). <br /> Add a line like<br /> <br /> <br /> def _NormFile(filename):<br /> filename = xbmc.translatePath(filename)<br /> try:<br /> ...<br /> <br /> The other three procedures are:<br /> * def _NormFile(filename):<br /> * def NormFileToServer(filename):<br /> * def NormFileToClient(filename):<br /> <br /> of course you need the import directive at the top of the file:<br /> <br /> import xbmc<br /> <br /> at the beginning of the module...<br /> <br /> ==== Choose how XBMC will refer to Pydev debugging module ====<br /> <br /> You have 3 options as below:<br /> * Option 1 - Refer from our python script directly the directory where pysrc is installed<br /> * Option 2 - Copy pysrc in our script directory and refer it from our script<br /> * Option 3 - Copy pysrc in XBMC Python install<br /> <br /> I am only going to show you the steps for ''Option 3'':<br /> <br /> ==== Copy pysrc in XBMC Python install ====<br /> * Copy the content of pysrc to:<br /> &lt;pre&gt;XBMC\system\python\Lib\pysrc\&lt;/pre&gt;<br /> * Add an empty __init__.py file in it<br /> <br /> === Add to your python script the code for remote debug ===<br /> At the beginning of you Python script/plugin (usually Default.py) add the following code:<br /> &lt;pre&gt;<br /> REMOTE_DBG = True <br /> <br /> # append pydev remote debugger<br /> if REMOTE_DBG:<br /> # Make pydev debugger works for auto reload.<br /> # Note pydevd module need to be copied in XBMC\system\python\Lib\pysrc<br /> try:<br /> import pysrc.pydevd as pydevd<br /> # stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console<br /> pydevd.settrace('localhost', stdoutToServer=True, stderrToServer=True)<br /> except ImportError:<br /> sys.stderr.write(&quot;Error: &quot; +<br /> &quot;You must add org.python.pydev.debug.pysrc to your PYTHONPATH.&quot;)<br /> sys.exit(1)<br /> &lt;/pre&gt;<br /> <br /> In the case you have change the default port you can replace the line with pydevd.settrace by this one:<br /> &lt;pre&gt;<br /> pydevd.settrace('localhost', port=5678, stdoutToServer=True, stderrToServer=True)<br /> &lt;/pre&gt;<br /> <br /> * Use REMOTE_DBG in order to activate or not the remote debugging<br /> * port specifies the listening port number use between the client and the server<br /> * Replace localhost by an IP address if XBMC and Eclipse are on 2 different machines<br /> * stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console, you won't have to open xbmc.log file<br /> <br /> <br /> <br /> === Run ===<br /> * Go in Debug view (Eclipse: [[File:changeperspective.png]] / Debug ) and press on the start server button: [[File:EclipsePydevDebugSrvButtons.png]]<br /> <br /> * You will see in the console logs like:<br /> &lt;pre&gt;Debug Server at port: 5678&lt;/pre&gt;<br /> <br /> * Start XBMC and run your script/plugin, you will see it as &quot;Running&quot; but paused<br /> <br /> * In Eclipse (Debug View) click on the Resume button (or F8), then you will see the program running in XBMC<br /> <br /> * You are now fully set up: You can set break-point, watch on variables, run step by step etc<br /> <br /> * Enjoy!<br /> <br /> === Screenshot ===<br /> <br /> [[File:EclipsePydevDebugger.png]]<br /> <br /> ==See also==<br /> * [[Add-ons]]<br /> * [[:Category:All add-ons]]<br /> * [[3rd party add-on repositories]]<br /> '''Development:'''<br /> * [[Add-on development]]<br /> * [[Addon Settings]]<br /> * [[Python development]]<br /> * [[Add-on repositories]]<br /> * [[Official add-on repository]]<br /> <br /> [[Category:Python]]<br /> [[Category:How-to]]<br /> [[Category:Add-on development]]</div>

Schapplm https://kodi.wiki/index.php?title=Archive:Debug_Python_Scripts_with_Eclipse&diff=78139 2014-08-24T16:21:22Z

<p>Schapplm: /* Identify where PyDev remote debugger Python files are */</p> <hr /> <div>{{mininav|[[Development]]|[[Add-on development]]|[[Python development]]}}<br /> <br /> Here is a method you can adopt in order to use the Eclipse (multi-platforms) remote debugger with your Python scripts/plugin.<br /> <br /> Note: Follow this link [[HOW-TO debug Python Scripts|Debugging Python Scripts on Linux with WinPDB]] for more information if you prefer to use WinPDB instead.<br /> <br /> Note: The information provided herein is also applicable to user with [http://www.aptana.com/ Aptana Studio 3] installation which come pre-installed with pydev. For this case, you can skip to [[#Configure Pydev and Eclipse|Configure Pydev and Eclipse]] after the Aptana Studio 3 installation.<br /> <br /> <br /> <br /> == Prerequisite ==<br /> * Any platform able to run [http://www.eclipse.org/downloads/ Eclipse IDE] (Windows 32bit-64bit, Mac Carbon 32bit-64bit, Mac Cocoa 32bit-64bit, Linux 32bit-64bit): it is the platform from where you will run the debugger IDE<br /> * Pyhton interpreter 2.4 (use the same version as XBMC or version &lt;= 2.7 ) install on the machine running Eclipse<br /> * Any platform running XBMC (Xbox, Linux, MACOSX, Windows): it is the platform running Python scripts/plugin connecting with the remote debugger.<br /> :XBMC installed on Ubuntu (should work just fine on Windows and Mac too)<br /> * [http://pydev.org/ Pydev] plugin for Eclipse IDE: Pydev is a Python IDE for Eclipse, which may be used in Python, Jython and IronPython development.<br /> <br /> <br /> <br /> <br /> == Prepare and Setup Eclipse ==<br /> <br /> === Install Eclipse ===<br /> * Download [http://www.eclipse.org/downloads/ Eclipse IDE] and install it<br /> Note: in our example Eclipse Galileo (3.5.1) is used<br /> <br /> <br /> <br /> === Install Pydev in Eclipse ===<br /> * In Eclipse go in: ''Help'' -&gt; ''Install New Software...''<br /> * Click on the ''Add'' button and add Pydev website as a source: http://pydev.org/updates<br /> * You will see the window below:<br /> [[File:EclipsePydevUpdate.png]]<br /> * Check ''PyDev'' box and follow the steps in order to install PyDev<br /> Note: in our example PyDev 1.5.5<br /> <br /> <br /> <br /> === Configure Pydev and Eclipse ===<br /> <br /> <br /> ==== Add Pyhton Interpreter Path ====<br /> * Go in ''Window'' -&gt; ''Preferences''<br /> * ''Pydev'' then ''Interpreter - Python''<br /> * Click on button ''New...''<br /> * In the new prompt, enter the ''Interpreter Name: Python'', and Browse for your Python Interpreter 2.4 ''python.exe'' file and select it. After that you should see something like this:<br /> [[File:EclipsePydevPref.png|none]]<br /> This will help in order to have Python code completion (except for XBMC modules)<br /> <br /> <br /> ==== Add Pydev view to Eclipse ====<br /> * On the top right corner click on the View button on select ''Others''<br /> [[File:EclipsePydevViewMenu.png]]<br /> * Select Pydev then OK, a PyDev View Button should be now available on the top right corner<br /> [[File:EclipsePydevViewMenu2.png]]<br /> Use this view for your developments in Python for XBMC<br /> <br /> <br /> ==== Add Pydev Start/Stop debug server buttons ====<br /> * In the menu bar select ''Window'' -&gt; ''Customize perspective...'', a window ''Customize Perspective - PyDev'' will open<br /> * Select ''Command Groups Availability'' Tab<br /> * Check ''Pydev Debug'' box and OK<br /> * You should see 2 new buttons in your toolbar:<br /> [[File:EclipsePydevDebugSrvButtons.png]]<br /> <br /> <br /> ==== Setting the remote debugger port (optional) ====<br /> If you do not want to use the default port (usually 5678) you can set it up:<br /> * Go to ''Window'' -&gt; ''Preferences''<br /> * ''Pydev'' then ''Debug'' you can define here the port and the timeout you want<br /> <br /> ==== Setting up Predefined Completions (optional) ====<br /> Many developers are accustom to using predefined completions when writing their code (eg. type-ahead). The standard Python completions are enabled by default when using these instructions, but the standard XBMC components will not be recognized appropriately (xbmc, xbmcgui, xbmcplugin, etc). <br /> <br /> In order to overcome this, you can run the [http://forum.xbmc.org/showthread.php?t=79070 PyDev Predefined Completions Creator addon] and [http://pydev.org/manual_101_interpreter.html#PyDevInterpreterConfiguration-PredefinedCompletions setup Eclipse] to reference this file:<br /> # Download the 'PyDev Predefined Completions Creator' Addon (eg. System &gt; Settings &gt; Addons &gt; XBMC.org &gt; Program Add-Ons)<br /> # Navigate to the newly installed Addon (eg. Programs from the home screen)<br /> # Open the context menu for newly installed addon and select 'Add-on Settings'<br /> # Set the location to save the help docs to and save the new settings (This can be anywhere on your system - we'll configure it in Eclipse later)<br /> # Select the add-on to run it (the addon should run and close quickly)<br /> # Open Eclipse and select Window &gt; Preferences &gt; PyDev &gt; Interpreter - Python<br /> # From the 'Predefined' tab, click the new button and select the folder you created in the step above<br /> # Press Apply / OK to ensure the changes are saved<br /> <br /> == Create a Python script/plugin for XBMC in Eclipse ==<br /> <br /> <br /> === Create a new PyDev Project ===<br /> Most of the time when you are doing development, likely that you are running XBMC and Eclipse on the same platform; (The installed debugger described in this article actually can also work with a remote XBMC).&lt;br\&gt;<br /> Let's say you already have scripts installed in XBMC script folder that you want to create a new PyDev project e.g.<br /> &lt;pre&gt;<br /> C:\XBMC\addons\myscript1<br /> C:\XBMC\addons\myscript2<br /> &lt;/pre&gt;<br /> <br /> With myscript1 &amp; myscript2 being sub-directories of ''C:\XBMC\addons'' each containing the Default.py scripts.&lt;br\&gt;<br /> First you need to define the Python project workspace:<br /> * ''File'' -&gt; ''Switch Workspace'' -&gt; ''Other...''<br /> * ''Browse'' to the parent directory of your script module i.e. ''C:\XBMC\addons'' in this example, select and OK<br /> Then proceed to create the Python project:<br /> * ''File'' -&gt; ''New'' -&gt; ''PyDev Project''<br /> : OR select below in case ''PyDev Project'' is not displayed<br /> * ''File'' -&gt; ''New'' -&gt; ''Others''; and Select ''Pydev'' then ''PyDev Project''; Click ''Next''<br /> * Enter the name of your project e.g. xbmc_addons<br /> * Uncheck option ''Use Default''<br /> * Browse to the directory of your scripts and select i.e. C:\XBMC\addons.<br /> * Set ''Python' as Project Type<br /> * Select ''2.4 (XBMC Python version)'' for the grammar<br /> * Select ''Don't configure PYTHONPATH (to be done manually later on)''<br /> * Click on ''Finish'' button<br /> <br /> <br /> === Set the Python Path ===<br /> * Right click on your new project and select ''Properties''<br /> * Select ''PyDev - PYTHONPATH'' and click on ''Add source folder''<br /> * Select the source directory of your script, /xbmc_addons in our example<br /> <br /> <br /> === Import File System ===<br /> Assuming you want to add in all the directories under C:\XBMC\addons<br /> * Right click on your new project and select ''Import...''<br /> * Select ''General'' and click on ''File System''; then ''Next''<br /> * Browse to the source directory of your script (or plugin) e.g. C:\XBMC\addons<br /> * Check the directory and files to be added<br /> * Select ''Into folder: xbmc_addons''<br /> * Select ''Options | &lt;&lt;Advanced | Create links in workspace''<br /> * Uncheck both the options i.e. ''Create virtual folders'' &amp; ''Create link locations relative to;...''<br /> * Click on ''Finish'' button<br /> Your source code is now recognized by Eclipse and you will have access to neat functionality such as code completion, link between source files, etc.<br /> <br /> <br /> === Add Pydev Python source code (pysrc) to XBMC ===<br /> XBMC needs to know where to find the PyDev remote python source file in order to communicate with the remote debugger of Eclipse.<br /> <br /> ==== Identify where PyDev remote debugger Python files are ====<br /> Python source files should be in you Eclipse installation directory:<br /> &lt;pre&gt;C:\...\eclipse\plugins\org.python.pydev.debug_1.5.5.2010030420\pysrc\&lt;/pre&gt;<br /> In our case we use PyDev 1.5.5. With newer versions of PyDev, the directory structure changed.<br /> &lt;pre&gt;C:\...\eclipse\plugins\org.python.pydev_3.6.0.201406232321\pysrc\&lt;/pre&gt;<br /> Look for org.python.pydev.debug (not core)<br /> <br /> ==== Modify PyDev source in order to support XBMC paths ====<br /> The pysrc code that came with Eclipse-pydev does not support XBMC paths (special://... or Q:/...) and the module would not find them making it impossible to insert breakpoints in such files.<br /> <br /> In order to add the support of XBMC paths, you will need to do a simple modification to the file ''pydevd_file_utils.py'' consisting on adding a line to each procedure that had a filename parameter (4 procedures in total). <br /> Add a line like<br /> <br /> <br /> def _NormFile(filename):<br /> filename = xbmc.translatePath(filename)<br /> try:<br /> ...<br /> <br /> The other three procedures are:<br /> * def _NormFile(filename):<br /> * def NormFileToServer(filename):<br /> * def NormFileToClient(filename):<br /> <br /> of course you need the import directive at the top of the file:<br /> <br /> import xbmc<br /> <br /> at the beginning of the module...<br /> <br /> ==== Choose how XBMC will refer to Pydev debugging module ====<br /> <br /> You have 3 options as below:<br /> * Option 1 - Refer from our python script directly the directory where pysrc is installed<br /> * Option 2 - Copy pysrc in our script directory and refer it from our script<br /> * Option 3 - Copy pysrc in XBMC Python install<br /> <br /> I am only going to show you the steps for ''Option 3'':<br /> <br /> ==== Copy pysrc in XBMC Python install ====<br /> * Copy the content of pysrc to:<br /> &lt;pre&gt;XBMC\system\python\Lib\pysrc\&lt;/pre&gt;<br /> * Add an empty __init__.py file in it<br /> <br /> === Add to your python script the code for remote debug ===<br /> At the beginning of you Python script/plugin (usually Default.py) add the following code:<br /> &lt;pre&gt;<br /> REMOTE_DBG = True <br /> <br /> # append pydev remote debugger<br /> if REMOTE_DBG:<br /> # Make pydev debugger works for auto reload.<br /> # Note pydevd module need to be copied in XBMC\system\python\Lib\pysrc<br /> try:<br /> import pysrc.pydevd as pydevd<br /> # stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console<br /> pydevd.settrace('localhost', stdoutToServer=True, stderrToServer=True)<br /> except ImportError:<br /> sys.stderr.write(&quot;Error: &quot; +<br /> &quot;You must add org.python.pydev.debug.pysrc to your PYTHONPATH.&quot;)<br /> sys.exit(1)<br /> &lt;/pre&gt;<br /> <br /> In the case you have change the default port you can replace the line with pydevd.settrace by this one:<br /> &lt;pre&gt;<br /> pydevd.settrace('localhost', port=5678, stdoutToServer=True, stderrToServer=True)<br /> &lt;/pre&gt;<br /> <br /> * Use REMOTE_DBG in order to activate or not the remote debugging<br /> * port specifies the listening port number use between the client and the server<br /> * Replace localhost by an IP address if XBMC and Eclipse are on 2 different machines<br /> * stdoutToServer and stderrToServer redirect stdout and stderr to eclipse console, you won't have to open xbmc.log file<br /> <br /> <br /> <br /> === Run ===<br /> * Go in Debug view (Eclipse: [[File:changeperspective.png]] / Debug ) and press on the start server button: [[File:EclipsePydevDebugSrvButtons.png]]<br /> <br /> * You will see in the console logs like:<br /> &lt;pre&gt;Debug Server at port: 5678&lt;/pre&gt;<br /> <br /> * Start XBMC and run your script/plugin, you will see it as &quot;Running&quot; but paused<br /> <br /> * In Eclipse (Debug View) click on the Resume button (or F8), then you will see the program running in XBMC<br /> <br /> * You are now fully set up: You can set break-point, watch on variables, run step by step etc<br /> <br /> * Enjoy!<br /> <br /> === Screenshot ===<br /> <br /> [[File:EclipsePydevDebugger.png]]<br /> <br /> ==See also==<br /> * [[Add-ons]]<br /> * [[:Category:All add-ons]]<br /> * [[3rd party add-on repositories]]<br /> '''Development:'''<br /> * [[Add-on development]]<br /> * [[Addon Settings]]<br /> * [[Python development]]<br /> * [[Add-on repositories]]<br /> * [[Official add-on repository]]<br /> <br /> [[Category:Python]]<br /> [[Category:How-to]]<br /> [[Category:Add-on development]]</div>

Schapplm https://kodi.wiki/index.php?title=HOW-TO:Modify_the_video_cache&diff=64500 2013-09-25T22:27:56Z

<p>Schapplm: </p> <hr /> <div>{{divbox|orange|| {{big|'''WARNING:''' These are considered advanced and experimental features. Some tags require a '''[[nightly build]]''' in order to work!}} }}[[Category:Gotham feature]]<br /> <br /> <br /> This page describes '''three [[advancedsettings.xml]] settings''' that can be used to maximize the video playback cache. You can use all or just a couple of these settings to see significant improvements in cache performance, should you require it ''(most users will not require these modifications)''. This can help with intermittent network issues, reduce how long the network is tied up, and/or improve battery life &lt;ref name=&quot;battery&quot;&gt;Certain devices (laptops, tablets, etc) that use sustained slow/medium-wifi usage, over the length of the video, will use more power than using fast-wifi usage for a shorter time. In other words, slowly loading a video file that is 30 minutes long, over a period of 30 minutes, can actually take more power than loading a 30 minute video in 5 minutes, even though more wifi speed/power is used during that 5 minutes.&lt;/ref&gt;.<br /> <br /> <br /> {{note|Even if you change the cache settings in XBMC, that won't change how fast the video file data comes in over the network: It won't make a slow server load the video any faster. It won't fix a slow local network.}}<br /> <br /> <br /> {{note|In v12 (Frodo), the video cache affects only media over HTTP and FTP protocol (local and internet sources). SMB and NFS are '''not''' cached. Check the resulting buffer size with [[Codecinfo|Codec Info]]. If you want to buffer a poor local network WLAN connection, you should access your sources via FTP protocol.}}<br /> <br /> <br /> <br /> {{TOC limit|2}}<br /> ==How-to modify the cache==<br /> If you don't already have an [[advancedsettings.xml]] file, it's very simple to make. XBMC uses this file for advanced settings and features that normal users shouldn't modify without first knowing what they do, as well as for experimental features, etc.<br /> <br /> # Since you can use all or just some of the following settings, let's start out with the basic file. Create a '''plain text file''' (no rich text formatting, don't use .doc, etc) and save it as '''advancedsettings.xml'''. Make sure that the file extension is &quot;.xml&quot; and '''not''' &quot;.txt&quot; or &quot;.xml.txt&quot;.<br /> # Cut and paste this into your new plain text file:<br /> #:&lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;advancedsettings&gt;<br /> &lt;network&gt;<br /> &lt;!--- The three settings will go in this space, between the two network tags. ---&gt;<br /> &lt;/network&gt;<br /> &lt;/advancedsettings&gt;<br /> &lt;/syntaxhighlight&gt;<br /> # Add some or all of the settings tags from the [[#Cache settings|next section]].<br /> # Save this file in your [[userdata folder]]:<br /> #:''If you have an existing file, make sure the &lt;network&gt;&lt;/network&gt; tags, and settings we'll add between them, are between the main &lt;advancedsettings&gt;&lt;/advancedsettings&gt; tags.''<br /> ::{{#lst:userdata|location all}}<br /> <br /> ==Cache settings==<br /> {| class=&quot;wikitable&quot;<br /> ! advancedsettings.xml tag !! what it does<br /> |-<br /> | &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;alwaysforcebuffer&gt;1&lt;/alwaysforcebuffer&gt;<br /> &lt;/syntaxhighlight&gt;<br /> || {{huge|'''Enable cache for local videos'''}}&lt;ref name=&quot;alwaysforcebuffer&quot;&gt;Requires XBMC v13alpha6 or higher&lt;/ref&gt;<br /> <br /> This setting will force XBMC to use a cache for all video files, including local network, internet, and even the local hard drive. We do this because by default XBMC will only cache videos that use internet file paths/sources.<br /> |-<br /> | &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;cachemembuffersize&gt;0&lt;/cachemembuffersize&gt;<br /> &lt;/syntaxhighlight&gt;<br /> || {{huge|'''Increasing the cache'''}}&lt;ref name=&quot;cachemembuffersize&quot;&gt;Requires XBMC v12.0 or higher&lt;/ref&gt;<br /> <br /> Here we can do two things:<br /> * '''{{Big|Value: 5242880}} -''' keep the cache in RAM, but increase how much RAM is used. The number is the buffer size in bytes ''(5242880 is the default, which is about 5MB, which requires 15MB of free RAM)''. XBMC will not buffer ahead more than this. {{Note|For the memory size set here, XBMC will require 3x the amount of RAM to be free. Setting this too high might cause XBMC to crash if it can't get enough RAM.}}<br /> '''''or'''''<br /> * '''{{Big|Value: 0}} -''' we can use the local disk memory (typically your hard drive), which will not put any limit on the size (outside of the size of your drive). This also allows devices with low RAM, such as the [[Raspberry Pi]], to cache more than they normally would due to the small amount of RAM they have. The cache is deleted from the local disk whenever playback is stopped. {{note|This will likely cause increased wear-and-tear on your drive.}}<br /> |-<br /> | &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;readbufferfactor&gt;4.0&lt;/readbufferfactor&gt;<br /> &lt;/syntaxhighlight&gt;<br /> || {{huge|'''Increase the fill-rate of the cache'''}}&lt;ref name=&quot;readbufferfactor&quot;&gt;Requires XBMC v13alpha7 or higher&lt;/ref&gt;<br /> <br /> By default '''(value: 1)''', XBMC will only fill the cache a little above what is needed to play it back. It does this as to not max out your network and possibly max out some hardware. For most users and hardware, this setting shouldn't cause any issues, but be aware of it if you have unusual CPU spikes in your HTPC. <br /> <br /> <br /> The value of this setting is a multiplier of the default limit. If XBMC is loading a typical bluray raw file at 36 Mbit/s, then a value of '''2''' will need at least 72 Mbit/s of network bandwidth. However, unlike with the RAM setting, you can safely increase this value however high you want, and XBMC won't crash. Just know that it might cause XBMC to attempt to use all available bandwidth on your HTPC during playback.<br /> |}<br /> <br /> ==Examples==<br /> ===Example 1===<br /> All three options enabled, using local hard drive for cache.<br /> ;advancedsettings.xml<br /> &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;advancedsettings&gt;<br /> &lt;network&gt;<br /> &lt;alwaysforcebuffer&gt;1&lt;/alwaysforcebuffer&gt;<br /> &lt;cachemembuffersize&gt;0&lt;/cachemembuffersize&gt;<br /> &lt;readbufferfactor&gt;4.0&lt;/readbufferfactor&gt;<br /> &lt;/network&gt;<br /> &lt;/advancedsettings&gt;<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ===Example 2===<br /> Only cache size changed, using 100MB of RAM for cache (which requires 300MB of free RAM).<br /> ;advancedsettings.xml<br /> &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;advancedsettings&gt;<br /> &lt;network&gt;<br /> &lt;cachemembuffersize&gt;104857600&lt;/cachemembuffersize&gt;<br /> &lt;/network&gt;<br /> &lt;/advancedsettings&gt;<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ===Example 3===<br /> Two options enabled, using 50MB of RAM for cache (which requires 150MB of free RAM), and cache both internet, LAN, and local content.<br /> ;advancedsettings.xml<br /> &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;advancedsettings&gt;<br /> &lt;network&gt;<br /> &lt;alwaysforcebuffer&gt;1&lt;/alwaysforcebuffer&gt;<br /> &lt;cachemembuffersize&gt;52428800&lt;/cachemembuffersize&gt;<br /> &lt;/network&gt;<br /> &lt;/advancedsettings&gt;<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==Notes==<br /> &lt;references /&gt;<br /> <br /> [[Category:Advanced topics]]<br /> [[Category:How-to]]<br /> [[Category:Video Library]]</div>

Schapplm https://kodi.wiki/index.php?title=HOW-TO:Modify_the_video_cache&diff=64499 2013-09-25T22:26:54Z

<p>Schapplm: </p> <hr /> <div>{{divbox|orange|| {{big|'''WARNING:''' These are considered advanced and experimental features. Some tags require a '''[[nightly build]]''' in order to work!}} }}[[Category:Gotham feature]]<br /> <br /> <br /> This page describes '''three [[advancedsettings.xml]] settings''' that can be used to maximize the video playback cache. You can use all or just a couple of these settings to see significant improvements in cache performance, should you require it ''(most users will not require these modifications)''. This can help with intermittent network issues, reduce how long the network is tied up, and/or improve battery life &lt;ref name=&quot;battery&quot;&gt;Certain devices (laptops, tablets, etc) that use sustained slow/medium-wifi usage, over the length of the video, will use more power than using fast-wifi usage for a shorter time. In other words, slowly loading a video file that is 30 minutes long, over a period of 30 minutes, can actually take more power than loading a 30 minute video in 5 minutes, even though more wifi speed/power is used during that 5 minutes.&lt;/ref&gt;.<br /> <br /> <br /> {{note|Even if you change the cache settings in XBMC, that won't change how fast the video file data comes in over the network: It won't make a slow server load the video any faster. It won't fix a slow local network.}}<br /> <br /> <br /> {{note|In v12 (Frodo), the video cache affects only media over HTTP and FTP protocol (local and internet sources). SMB and NFS are '''not''' cached. Check the resulting buffer size with [[Codecinfo|Codec Info]].}}<br /> <br /> <br /> <br /> {{TOC limit|2}}<br /> ==How-to modify the cache==<br /> If you don't already have an [[advancedsettings.xml]] file, it's very simple to make. XBMC uses this file for advanced settings and features that normal users shouldn't modify without first knowing what they do, as well as for experimental features, etc.<br /> <br /> # Since you can use all or just some of the following settings, let's start out with the basic file. Create a '''plain text file''' (no rich text formatting, don't use .doc, etc) and save it as '''advancedsettings.xml'''. Make sure that the file extension is &quot;.xml&quot; and '''not''' &quot;.txt&quot; or &quot;.xml.txt&quot;.<br /> # Cut and paste this into your new plain text file:<br /> #:&lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;advancedsettings&gt;<br /> &lt;network&gt;<br /> &lt;!--- The three settings will go in this space, between the two network tags. ---&gt;<br /> &lt;/network&gt;<br /> &lt;/advancedsettings&gt;<br /> &lt;/syntaxhighlight&gt;<br /> # Add some or all of the settings tags from the [[#Cache settings|next section]].<br /> # Save this file in your [[userdata folder]]:<br /> #:''If you have an existing file, make sure the &lt;network&gt;&lt;/network&gt; tags, and settings we'll add between them, are between the main &lt;advancedsettings&gt;&lt;/advancedsettings&gt; tags.''<br /> ::{{#lst:userdata|location all}}<br /> <br /> ==Cache settings==<br /> {| class=&quot;wikitable&quot;<br /> ! advancedsettings.xml tag !! what it does<br /> |-<br /> | &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;alwaysforcebuffer&gt;1&lt;/alwaysforcebuffer&gt;<br /> &lt;/syntaxhighlight&gt;<br /> || {{huge|'''Enable cache for local videos'''}}&lt;ref name=&quot;alwaysforcebuffer&quot;&gt;Requires XBMC v13alpha6 or higher&lt;/ref&gt;<br /> <br /> This setting will force XBMC to use a cache for all video files, including local network, internet, and even the local hard drive. We do this because by default XBMC will only cache videos that use internet file paths/sources.<br /> |-<br /> | &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;cachemembuffersize&gt;0&lt;/cachemembuffersize&gt;<br /> &lt;/syntaxhighlight&gt;<br /> || {{huge|'''Increasing the cache'''}}&lt;ref name=&quot;cachemembuffersize&quot;&gt;Requires XBMC v12.0 or higher&lt;/ref&gt;<br /> <br /> Here we can do two things:<br /> * '''{{Big|Value: 5242880}} -''' keep the cache in RAM, but increase how much RAM is used. The number is the buffer size in bytes ''(5242880 is the default, which is about 5MB, which requires 15MB of free RAM)''. XBMC will not buffer ahead more than this. {{Note|For the memory size set here, XBMC will require 3x the amount of RAM to be free. Setting this too high might cause XBMC to crash if it can't get enough RAM.}}<br /> '''''or'''''<br /> * '''{{Big|Value: 0}} -''' we can use the local disk memory (typically your hard drive), which will not put any limit on the size (outside of the size of your drive). This also allows devices with low RAM, such as the [[Raspberry Pi]], to cache more than they normally would due to the small amount of RAM they have. The cache is deleted from the local disk whenever playback is stopped. {{note|This will likely cause increased wear-and-tear on your drive.}}<br /> |-<br /> | &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;readbufferfactor&gt;4.0&lt;/readbufferfactor&gt;<br /> &lt;/syntaxhighlight&gt;<br /> || {{huge|'''Increase the fill-rate of the cache'''}}&lt;ref name=&quot;readbufferfactor&quot;&gt;Requires XBMC v13alpha7 or higher&lt;/ref&gt;<br /> <br /> By default '''(value: 1)''', XBMC will only fill the cache a little above what is needed to play it back. It does this as to not max out your network and possibly max out some hardware. For most users and hardware, this setting shouldn't cause any issues, but be aware of it if you have unusual CPU spikes in your HTPC. <br /> <br /> <br /> The value of this setting is a multiplier of the default limit. If XBMC is loading a typical bluray raw file at 36 Mbit/s, then a value of '''2''' will need at least 72 Mbit/s of network bandwidth. However, unlike with the RAM setting, you can safely increase this value however high you want, and XBMC won't crash. Just know that it might cause XBMC to attempt to use all available bandwidth on your HTPC during playback.<br /> |}<br /> <br /> ==Examples==<br /> ===Example 1===<br /> All three options enabled, using local hard drive for cache.<br /> ;advancedsettings.xml<br /> &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;advancedsettings&gt;<br /> &lt;network&gt;<br /> &lt;alwaysforcebuffer&gt;1&lt;/alwaysforcebuffer&gt;<br /> &lt;cachemembuffersize&gt;0&lt;/cachemembuffersize&gt;<br /> &lt;readbufferfactor&gt;4.0&lt;/readbufferfactor&gt;<br /> &lt;/network&gt;<br /> &lt;/advancedsettings&gt;<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ===Example 2===<br /> Only cache size changed, using 100MB of RAM for cache (which requires 300MB of free RAM).<br /> ;advancedsettings.xml<br /> &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;advancedsettings&gt;<br /> &lt;network&gt;<br /> &lt;cachemembuffersize&gt;104857600&lt;/cachemembuffersize&gt;<br /> &lt;/network&gt;<br /> &lt;/advancedsettings&gt;<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ===Example 3===<br /> Two options enabled, using 50MB of RAM for cache (which requires 150MB of free RAM), and cache both internet, LAN, and local content.<br /> ;advancedsettings.xml<br /> &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;advancedsettings&gt;<br /> &lt;network&gt;<br /> &lt;alwaysforcebuffer&gt;1&lt;/alwaysforcebuffer&gt;<br /> &lt;cachemembuffersize&gt;52428800&lt;/cachemembuffersize&gt;<br /> &lt;/network&gt;<br /> &lt;/advancedsettings&gt;<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==Notes==<br /> &lt;references /&gt;<br /> <br /> [[Category:Advanced topics]]<br /> [[Category:How-to]]<br /> [[Category:Video Library]]</div>

Schapplm https://kodi.wiki/index.php?title=HOW-TO:Modify_the_video_cache&diff=64498 2013-09-25T22:26:25Z

<p>Schapplm: </p> <hr /> <div>{{divbox|orange|| {{big|'''WARNING:''' These are considered advanced and experimental features. Some tags require a '''[[nightly build]]''' in order to work!}} }}[[Category:Gotham feature]]<br /> <br /> <br /> This page describes '''three [[advancedsettings.xml]] settings''' that can be used to maximize the video playback cache. You can use all or just a couple of these settings to see significant improvements in cache performance, should you require it ''(most users will not require these modifications)''. This can help with intermittent network issues, reduce how long the network is tied up, and/or improve battery life &lt;ref name=&quot;battery&quot;&gt;Certain devices (laptops, tablets, etc) that use sustained slow/medium-wifi usage, over the length of the video, will use more power than using fast-wifi usage for a shorter time. In other words, slowly loading a video file that is 30 minutes long, over a period of 30 minutes, can actually take more power than loading a 30 minute video in 5 minutes, even though more wifi speed/power is used during that 5 minutes.&lt;/ref&gt;.<br /> <br /> <br /> {{note|Even if you change the cache settings in XBMC, that won't change how fast the video file data comes in over the network: It won't make a slow server load the video any faster. It won't fix a slow local network.}}<br /> <br /> <br /> {{note|In v12 (Frodo), the video cache affects only media over HTTP and FTP protocol (local and internet sources). SMB and NFS are '''not''' cached. Check the resulting buffer size with [[Codecinfo|Codec Info]]}}<br /> <br /> <br /> <br /> {{TOC limit|2}}<br /> ==How-to modify the cache==<br /> If you don't already have an [[advancedsettings.xml]] file, it's very simple to make. XBMC uses this file for advanced settings and features that normal users shouldn't modify without first knowing what they do, as well as for experimental features, etc.<br /> <br /> # Since you can use all or just some of the following settings, let's start out with the basic file. Create a '''plain text file''' (no rich text formatting, don't use .doc, etc) and save it as '''advancedsettings.xml'''. Make sure that the file extension is &quot;.xml&quot; and '''not''' &quot;.txt&quot; or &quot;.xml.txt&quot;.<br /> # Cut and paste this into your new plain text file:<br /> #:&lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;advancedsettings&gt;<br /> &lt;network&gt;<br /> &lt;!--- The three settings will go in this space, between the two network tags. ---&gt;<br /> &lt;/network&gt;<br /> &lt;/advancedsettings&gt;<br /> &lt;/syntaxhighlight&gt;<br /> # Add some or all of the settings tags from the [[#Cache settings|next section]].<br /> # Save this file in your [[userdata folder]]:<br /> #:''If you have an existing file, make sure the &lt;network&gt;&lt;/network&gt; tags, and settings we'll add between them, are between the main &lt;advancedsettings&gt;&lt;/advancedsettings&gt; tags.''<br /> ::{{#lst:userdata|location all}}<br /> <br /> ==Cache settings==<br /> {| class=&quot;wikitable&quot;<br /> ! advancedsettings.xml tag !! what it does<br /> |-<br /> | &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;alwaysforcebuffer&gt;1&lt;/alwaysforcebuffer&gt;<br /> &lt;/syntaxhighlight&gt;<br /> || {{huge|'''Enable cache for local videos'''}}&lt;ref name=&quot;alwaysforcebuffer&quot;&gt;Requires XBMC v13alpha6 or higher&lt;/ref&gt;<br /> <br /> This setting will force XBMC to use a cache for all video files, including local network, internet, and even the local hard drive. We do this because by default XBMC will only cache videos that use internet file paths/sources.<br /> |-<br /> | &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;cachemembuffersize&gt;0&lt;/cachemembuffersize&gt;<br /> &lt;/syntaxhighlight&gt;<br /> || {{huge|'''Increasing the cache'''}}&lt;ref name=&quot;cachemembuffersize&quot;&gt;Requires XBMC v12.0 or higher&lt;/ref&gt;<br /> <br /> Here we can do two things:<br /> * '''{{Big|Value: 5242880}} -''' keep the cache in RAM, but increase how much RAM is used. The number is the buffer size in bytes ''(5242880 is the default, which is about 5MB, which requires 15MB of free RAM)''. XBMC will not buffer ahead more than this. {{Note|For the memory size set here, XBMC will require 3x the amount of RAM to be free. Setting this too high might cause XBMC to crash if it can't get enough RAM.}}<br /> '''''or'''''<br /> * '''{{Big|Value: 0}} -''' we can use the local disk memory (typically your hard drive), which will not put any limit on the size (outside of the size of your drive). This also allows devices with low RAM, such as the [[Raspberry Pi]], to cache more than they normally would due to the small amount of RAM they have. The cache is deleted from the local disk whenever playback is stopped. {{note|This will likely cause increased wear-and-tear on your drive.}}<br /> |-<br /> | &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;readbufferfactor&gt;4.0&lt;/readbufferfactor&gt;<br /> &lt;/syntaxhighlight&gt;<br /> || {{huge|'''Increase the fill-rate of the cache'''}}&lt;ref name=&quot;readbufferfactor&quot;&gt;Requires XBMC v13alpha7 or higher&lt;/ref&gt;<br /> <br /> By default '''(value: 1)''', XBMC will only fill the cache a little above what is needed to play it back. It does this as to not max out your network and possibly max out some hardware. For most users and hardware, this setting shouldn't cause any issues, but be aware of it if you have unusual CPU spikes in your HTPC. <br /> <br /> <br /> The value of this setting is a multiplier of the default limit. If XBMC is loading a typical bluray raw file at 36 Mbit/s, then a value of '''2''' will need at least 72 Mbit/s of network bandwidth. However, unlike with the RAM setting, you can safely increase this value however high you want, and XBMC won't crash. Just know that it might cause XBMC to attempt to use all available bandwidth on your HTPC during playback.<br /> |}<br /> <br /> ==Examples==<br /> ===Example 1===<br /> All three options enabled, using local hard drive for cache.<br /> ;advancedsettings.xml<br /> &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;advancedsettings&gt;<br /> &lt;network&gt;<br /> &lt;alwaysforcebuffer&gt;1&lt;/alwaysforcebuffer&gt;<br /> &lt;cachemembuffersize&gt;0&lt;/cachemembuffersize&gt;<br /> &lt;readbufferfactor&gt;4.0&lt;/readbufferfactor&gt;<br /> &lt;/network&gt;<br /> &lt;/advancedsettings&gt;<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ===Example 2===<br /> Only cache size changed, using 100MB of RAM for cache (which requires 300MB of free RAM).<br /> ;advancedsettings.xml<br /> &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;advancedsettings&gt;<br /> &lt;network&gt;<br /> &lt;cachemembuffersize&gt;104857600&lt;/cachemembuffersize&gt;<br /> &lt;/network&gt;<br /> &lt;/advancedsettings&gt;<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ===Example 3===<br /> Two options enabled, using 50MB of RAM for cache (which requires 150MB of free RAM), and cache both internet, LAN, and local content.<br /> ;advancedsettings.xml<br /> &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;advancedsettings&gt;<br /> &lt;network&gt;<br /> &lt;alwaysforcebuffer&gt;1&lt;/alwaysforcebuffer&gt;<br /> &lt;cachemembuffersize&gt;52428800&lt;/cachemembuffersize&gt;<br /> &lt;/network&gt;<br /> &lt;/advancedsettings&gt;<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==Notes==<br /> &lt;references /&gt;<br /> <br /> [[Category:Advanced topics]]<br /> [[Category:How-to]]<br /> [[Category:Video Library]]</div>

Schapplm https://kodi.wiki/index.php?title=HOW-TO:Modify_the_video_cache&diff=64497 2013-09-25T22:25:50Z

<p>Schapplm: </p> <hr /> <div>{{divbox|orange|| {{big|'''WARNING:''' These are considered advanced and experimental features. Some tags require a '''[[nightly build]]''' in order to work!}} }}[[Category:Gotham feature]]<br /> <br /> <br /> This page describes '''three [[advancedsettings.xml]] settings''' that can be used to maximize the video playback cache. You can use all or just a couple of these settings to see significant improvements in cache performance, should you require it ''(most users will not require these modifications)''. This can help with intermittent network issues, reduce how long the network is tied up, and/or improve battery life &lt;ref name=&quot;battery&quot;&gt;Certain devices (laptops, tablets, etc) that use sustained slow/medium-wifi usage, over the length of the video, will use more power than using fast-wifi usage for a shorter time. In other words, slowly loading a video file that is 30 minutes long, over a period of 30 minutes, can actually take more power than loading a 30 minute video in 5 minutes, even though more wifi speed/power is used during that 5 minutes.&lt;/ref&gt;.<br /> <br /> <br /> {{note|Even if you change the cache settings in XBMC, that won't change how fast the video file data comes in over the network: It won't make a slow server load the video any faster. It won't fix a slow local network.}}<br /> <br /> <br /> {{note|In v12 (Frodo), the video cache affects only media over HTTP and FTP protocol (local and internet sources). SMB and NFS are '''not''' cached. Check the resulting buffer size with [[#Codecinfo|Codec Info]]}}<br /> <br /> <br /> <br /> {{TOC limit|2}}<br /> ==How-to modify the cache==<br /> If you don't already have an [[advancedsettings.xml]] file, it's very simple to make. XBMC uses this file for advanced settings and features that normal users shouldn't modify without first knowing what they do, as well as for experimental features, etc.<br /> <br /> # Since you can use all or just some of the following settings, let's start out with the basic file. Create a '''plain text file''' (no rich text formatting, don't use .doc, etc) and save it as '''advancedsettings.xml'''. Make sure that the file extension is &quot;.xml&quot; and '''not''' &quot;.txt&quot; or &quot;.xml.txt&quot;.<br /> # Cut and paste this into your new plain text file:<br /> #:&lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;advancedsettings&gt;<br /> &lt;network&gt;<br /> &lt;!--- The three settings will go in this space, between the two network tags. ---&gt;<br /> &lt;/network&gt;<br /> &lt;/advancedsettings&gt;<br /> &lt;/syntaxhighlight&gt;<br /> # Add some or all of the settings tags from the [[#Cache settings|next section]].<br /> # Save this file in your [[userdata folder]]:<br /> #:''If you have an existing file, make sure the &lt;network&gt;&lt;/network&gt; tags, and settings we'll add between them, are between the main &lt;advancedsettings&gt;&lt;/advancedsettings&gt; tags.''<br /> ::{{#lst:userdata|location all}}<br /> <br /> ==Cache settings==<br /> {| class=&quot;wikitable&quot;<br /> ! advancedsettings.xml tag !! what it does<br /> |-<br /> | &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;alwaysforcebuffer&gt;1&lt;/alwaysforcebuffer&gt;<br /> &lt;/syntaxhighlight&gt;<br /> || {{huge|'''Enable cache for local videos'''}}&lt;ref name=&quot;alwaysforcebuffer&quot;&gt;Requires XBMC v13alpha6 or higher&lt;/ref&gt;<br /> <br /> This setting will force XBMC to use a cache for all video files, including local network, internet, and even the local hard drive. We do this because by default XBMC will only cache videos that use internet file paths/sources.<br /> |-<br /> | &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;cachemembuffersize&gt;0&lt;/cachemembuffersize&gt;<br /> &lt;/syntaxhighlight&gt;<br /> || {{huge|'''Increasing the cache'''}}&lt;ref name=&quot;cachemembuffersize&quot;&gt;Requires XBMC v12.0 or higher&lt;/ref&gt;<br /> <br /> Here we can do two things:<br /> * '''{{Big|Value: 5242880}} -''' keep the cache in RAM, but increase how much RAM is used. The number is the buffer size in bytes ''(5242880 is the default, which is about 5MB, which requires 15MB of free RAM)''. XBMC will not buffer ahead more than this. {{Note|For the memory size set here, XBMC will require 3x the amount of RAM to be free. Setting this too high might cause XBMC to crash if it can't get enough RAM.}}<br /> '''''or'''''<br /> * '''{{Big|Value: 0}} -''' we can use the local disk memory (typically your hard drive), which will not put any limit on the size (outside of the size of your drive). This also allows devices with low RAM, such as the [[Raspberry Pi]], to cache more than they normally would due to the small amount of RAM they have. The cache is deleted from the local disk whenever playback is stopped. {{note|This will likely cause increased wear-and-tear on your drive.}}<br /> |-<br /> | &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;readbufferfactor&gt;4.0&lt;/readbufferfactor&gt;<br /> &lt;/syntaxhighlight&gt;<br /> || {{huge|'''Increase the fill-rate of the cache'''}}&lt;ref name=&quot;readbufferfactor&quot;&gt;Requires XBMC v13alpha7 or higher&lt;/ref&gt;<br /> <br /> By default '''(value: 1)''', XBMC will only fill the cache a little above what is needed to play it back. It does this as to not max out your network and possibly max out some hardware. For most users and hardware, this setting shouldn't cause any issues, but be aware of it if you have unusual CPU spikes in your HTPC. <br /> <br /> <br /> The value of this setting is a multiplier of the default limit. If XBMC is loading a typical bluray raw file at 36 Mbit/s, then a value of '''2''' will need at least 72 Mbit/s of network bandwidth. However, unlike with the RAM setting, you can safely increase this value however high you want, and XBMC won't crash. Just know that it might cause XBMC to attempt to use all available bandwidth on your HTPC during playback.<br /> |}<br /> <br /> ==Examples==<br /> ===Example 1===<br /> All three options enabled, using local hard drive for cache.<br /> ;advancedsettings.xml<br /> &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;advancedsettings&gt;<br /> &lt;network&gt;<br /> &lt;alwaysforcebuffer&gt;1&lt;/alwaysforcebuffer&gt;<br /> &lt;cachemembuffersize&gt;0&lt;/cachemembuffersize&gt;<br /> &lt;readbufferfactor&gt;4.0&lt;/readbufferfactor&gt;<br /> &lt;/network&gt;<br /> &lt;/advancedsettings&gt;<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ===Example 2===<br /> Only cache size changed, using 100MB of RAM for cache (which requires 300MB of free RAM).<br /> ;advancedsettings.xml<br /> &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;advancedsettings&gt;<br /> &lt;network&gt;<br /> &lt;cachemembuffersize&gt;104857600&lt;/cachemembuffersize&gt;<br /> &lt;/network&gt;<br /> &lt;/advancedsettings&gt;<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ===Example 3===<br /> Two options enabled, using 50MB of RAM for cache (which requires 150MB of free RAM), and cache both internet, LAN, and local content.<br /> ;advancedsettings.xml<br /> &lt;syntaxhighlight lang=&quot;xml&quot; enclose=&quot;div&quot;&gt;<br /> &lt;advancedsettings&gt;<br /> &lt;network&gt;<br /> &lt;alwaysforcebuffer&gt;1&lt;/alwaysforcebuffer&gt;<br /> &lt;cachemembuffersize&gt;52428800&lt;/cachemembuffersize&gt;<br /> &lt;/network&gt;<br /> &lt;/advancedsettings&gt;<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==Notes==<br /> &lt;references /&gt;<br /> <br /> [[Category:Advanced topics]]<br /> [[Category:How-to]]<br /> [[Category:Video Library]]</div>

Schapplm https://kodi.wiki/index.php?title=List_of_built-in_functions&diff=64004 2013-09-05T15:40:24Z

<p>Schapplm: /* All Platforms */</p> <hr /> <div>{{mininav|[[Development]]}}<br /> <br /> {{see also|Python development|Skinning}}<br /> <br /> {{cleanup}}<br /> The latest up-to-date list of built-in functions can be found in the function '''CBuiltins::Execute()''' in the source code file [https://github.com/xbmc/xbmc/blob/master/xbmc/interfaces/Builtins.cpp xbmc/interfaces/Builtins.cpp].<br /> <br /> In addition to the following list, for most &lt;onclick&gt; and &lt;onfocus&gt; button actions in the skin you can also use the functions from [[Keyboard.xml]].<br /> &lt;br /&gt;<br /> <br /> '''Example:'''&lt;br /&gt;<br /> &lt;onclick&gt;VolumeUp&lt;/onclick&gt;&lt;br /&gt;<br /> &lt;onclick&gt;VolumeDown&lt;/onclick&gt;&lt;br /&gt;<br /> <br /> '''You can use parameters with all media windows, as can be seen here:'''<br /> * [[Opening Windows and Dialogs]]&lt;br /&gt;<br /> <br /> == All Platforms ==<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |- <br /> | Reboot<br /> | Cold reboots the system (power cycle)<br /> |- <br /> | ShutDown<br /> | Trigger default Shutdown action defined in System Settings<br /> |- <br /> | Powerdown<br /> | Powerdown system<br /> |- <br /> | Quit<br /> | Quits XBMC<br /> |- <br /> | Hibernate<br /> | Hibernate (S4) the System<br /> |- <br /> | Suspend<br /> | Suspends (S3 / S1 depending on bios setting) the System<br /> |- <br /> | RestartApp<br /> | Restarts XBMC (not implemented under Win32)<br /> |- <br /> | Minimize<br /> | Minimizes XBMC<br /> |- <br /> | Credits<br /> | Runs the Credits<br /> |- <br /> | Mastermode<br /> | Runs XBMC in master mode<br /> |- <br /> | ActivateWindow(window[,dir,return])<br /> | Opens the given window. The parameter window can either be the window's id, or in the case of a standard window, the window's name. [[Window IDs|See here for a list of window names, and their respective ids.]] If, furthermore, the window is Music, Video, Pictures, or Program files, then the optional dir parameter specifies which folder XBMC should default to once the window is opened. This must be a source as specified in sources.xml, or a subfolder of a valid source. For some windows (MusicLibrary and VideoLibrary), the return parameter may be specified, which indicates that XBMC should use this folder as the &quot;root&quot; of the level, and thus the &quot;parent directory&quot; action from within this folder will return the user to where they were prior to the window activating.<br /> |-{{frodo row}}<br /> | ActivateWindowAndFocus(id1, id2,item1, id3,item2)<br /> | Activate window with id1, first focus control id2 and then focus control id3. if either of the controls is a container, you can specify which item to focus (else, set it to 0).'''([[:Category:Frodo feature|Future Frodo addition]])'''<br /> |-<br /> | ReplaceWindowAndFocus(id1, id2,item1, id3,item2)<br /> | Replace window with id1, first focus control id2 and then focus control id3. if either of the controls is a container, you can specify which item to focus (else, set it to 0).'''([[:Category:Gotham feature|Future Gotham addition]])'''<br /> |-<br /> | ReplaceWindow(window,dir)<br /> | Replaces the current window with the given window. This is the same as ActivateWindow() but it doesn't update the window history list, so when you go back from the new window it will not return to the previous window, rather will return to the previous window's previous window.<br /> |- <br /> | TakeScreenshot<br /> | Takes a Screenshot<br /> |-<br /> | ActivateScreensaver<br /> | Starts the screensaver '''([[:Category:Gotham feature|Future Gotham addition]])'''<br /> |-<br /> | RunScript(script[,args]*)<br /> | Runs the python script. You must specify the full path to the script. If the script is an add-on, you can also execute it using its add-on id. As of 2007/02/24, all extra parameters are passed to the script as arguments and can be accessed by python using sys.argv<br /> |- <br /> | RunAddon(id)<br /> | Runs the specified plugin/script<br /> |- <br /> | RunPlugin(plugin)<br /> | Runs the plugin. Full path must be specified. Does not work for folder plugins<br /> |- <br /> | RunAppleScript(script[,args]*)<br /> | Run the specified AppleScript command<br /> |- <br /> | Extract<br /> | Extracts a specified archive to an optionally specified path. &lt;font color=&quot;red&quot;&gt;! REQUIRES ABSOLUTE PATHS !&lt;/font&gt;<br /> |- {{frodo row}}<br /> | Filter<br /> | Opens the mediafilter dialog in the video and musiclibrary '''([[:Category:Frodo feature|Future Frodo addition]])'''<br /> |- <br /> | PlayMedia(media[,isdir][,1],[playoffset=xx])<br /> | Plays the media. This can be a playlist, music, or video file, directory, plugin or an Url. The optional parameter &quot;,isdir&quot; can be used for playing a directory. &quot;,1&quot; will start a video in a preview window, instead of fullscreen. If media is a playlist, you can use playoffset=xx where xx is the position to start playback from.<br /> |- <br /> | SlideShow(dir [,recursive, [not]random])<br /> | Starts a slideshow of pictures in the folder dir. Optional parameters are &quot;recursive&quot;, and &quot;random&quot; or &quot;notrandom&quot; parameters. The &quot;recursive&quot; parameter starts a recursive slideshow, adding images from sub-folders. The &quot;random&quot; and &quot;notrandom&quot; parameters override the Randomize setting found in the pictures media window. <br /> |- <br /> | RecursiveSlideShow(dir)<br /> | Run a slideshow from the specified directory, including all subdirs<br /> |- <br /> | ReloadSkin()<br /> | Reloads the current skin – useful for Skinners to use after they upload modified skin files (saves power cycling)<br /> |- <br /> | RefreshRSS<br /> | Reload RSS feeds from RSSFeeds.xml<br /> |- <br /> | PlayerControl(command)<br /> | Allows control of music and videos. The command may be one of Play, Stop, Forward, Rewind, Next, Previous, BigSkipForward, BigSkipBackward, SmallSkipForward, SmallSkipBackward, Random, RandomOn, RandomOff, Repeat, RepeatOne, RepeatAll, RepeatOff, Partymode(music) or Partymode(video) or Partymode(path to .xsp file), and Record. Play will either pause, resume, or stop ffwding or rewinding. Random toggles random playback and Repeat cycles through the repeat modes (these both take an optional second parameter, Notify, that notifies the user of the new state). Partymode(music/video) toggles the appropriate partymode, defaults to music if no parameter is given, besides the default music or video partymode you can also pass a path to a custom smartplaylist (.xsp) as parameter.<br /> |- <br /> | Playlist.PlayOffset<br /> | Start playing from a particular offset in the playlist<br /> |- <br /> | Playlist.Clear<br /> | Clear the current playlist<br /> |-<br /> | XBMC.ActivateWindow(type,path to playlist)<br /> | Opens the window for the desired playlist<br /> |- <br /> | EjectTray()<br /> | Either opens or closes the DVD tray, depending on its current state<br /> |- <br /> | AlarmClock(name,command,time[,silent,loop])<br /> | Pops up a dialog asking for the length of time for the alarm (unless the parameter time is specified), and starts a timer. When the timer runs out, it'll execute the &lt;span class=&quot;nobr&quot;&gt;built-in&lt;/span&gt; command (the parameter command) if it is specified, otherwise it'll pop up an alarm notice. Add silent to hide the alarm notification. Add loop for the alarm to execute the command each time the specified time interval expires. <br /> |- <br /> | CancelAlarm(name[,silent])<br /> | Cancel a running alarm. Set silent to true to hide the alarm notification. only available in trunk &gt;r35674 <br /> |- <br /> | Action<br /> | Executes an action for the active window (same as in keymap)<br /> |- <br /> | Notification(header,message[,time,image])<br /> | Will display a notification dialog with the specified header and message, in addition you can set the length of time it displays in milliseconds and a icon image.<br /> |- <br /> | PlayDVD<br /> | Will play the inserted CD or DVD media from the &lt;span class=&quot;nobr&quot;&gt;DVD-ROM&lt;/span&gt; drive.<br /> |- <br /> | RipCD<br /> | Will rip the inserted CD from the &lt;span class=&quot;nobr&quot;&gt;DVD-ROM&lt;/span&gt; drive.<br /> |- <br /> | Skin.ToggleSetting(setting)<br /> | Toggles the skin setting ?setting? for use with [[Conditional Visibility|conditional visibility tags]] containing Skin.HasSetting(setting).<br /> |- <br /> | Skin.SetString(string[,value])<br /> | Pops up a keyboard dialog and allows the user to input a string which can be used in a label control elsewhere in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the keyboard dialog does not pop up, and the string is set directly.<br /> |- <br /> | Skin.SetNumeric(numeric[,value])<br /> | Pops up a keyboard dialog and allows the user to input a numerical.<br /> |- <br /> | Skin.SetPath(string[,value])<br /> | Pops up a folder browser and allows the user to select a folder of images to be used in a multi image control else where in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the path is set directly.<br /> |- <br /> | Skin.Theme<br /> | Cycles the skin theme. Skin.theme(-1) will go backwards.<br /> |- <br /> | Skin.SetImage(string[,value])<br /> | Pops up a file browser and allows the user to select an image file to be used in an image control elsewhere in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly.<br /> |- <br /> | Skin.SetLargeImage(string[,value])<br /> | Pops up a file browser and allows the user to select an large image file to be used in an image control else where in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the value parameter is specified, then the file browser dialog does not pop up, and the image path is set directly.<br /> |- <br /> | Skin.SetFile(string,mask,folderpath)<br /> | Pops up a folder browser and allows the user to select a file off the hard-disk to be used else where in the skin via the [[InfoLabels|info tag]] Skin.String(string). If the mask parameter is specified, then the file browser will only search for the extension specified (.avi,.mp3,.m3u,.png,.bmp,etc.,etc.). To use multiple extensions separate them using &quot;|&quot; minus quotes. If the folderpath parameter is set the file browser will start in that folder.<br /> |- <br /> | Skin.SetAddon(string,type)<br /> | Pops up a select dialog and allows the user to select an add-on of the given type to be used elsewhere in the skin via the info tag Skin.String(string). The most common types are ''xbmc.addon.video'', ''xbmc.addon.audio'', ''xbmc.addon.image'' and ''xbmc.addon.executable''.<br /> |- <br /> | Skin.SetBool(setting)<br /> | Sets the skin setting ?setting? to true, for use with the [[Conditional Visibility|conditional visibility tags]] containing Skin.HasSetting(setting). The settings are saved &lt;span class=&quot;nobr&quot;&gt;per-skin&lt;/span&gt; in settings.xml just like all the other XBMC settings.<br /> |- <br /> | Skin.Reset(setting)<br /> | Resets the skin setting ?setting?. If ?setting? is a bool setting (i.e. set via SetBool or ToggleSetting) then the setting is reset to false. If ?setting? is a string (Set via SetString, SetImage, or SetPath) then it is set to empty.<br /> |- <br /> | Skin.ResetSettings<br /> | Resets all the above skin settings to their defaults (toggles all set to false, strings all set to empty.)<br /> |- <br /> | Mute<br /> | Mutes (or unmutes) the volume.<br /> |- <br /> | SetVolume(percent[,showvolumebar])<br /> | Sets the volume to the percentage specified. Optionally, show the Volume Dialog in XBMC when setting the volume.<br /> |- <br /> | Dialog.Close(dialog[,force])<br /> | Close a dialog. Set force to true to bypass animations. Use (all,true) to close all opened dialogs at once.<br /> |- <br /> | System.LogOff<br /> | Log off current user.<br /> |- <br /> | System.Exec<br /> | Execute shell commands.<br /> |- <br /> | System.ExecWait<br /> | Execute shell commands and freezes XBMC until shell is closed.<br /> |-{{frodo row}}<br /> | AllowIdleShutdown<br /> | Allow the system to shutdown on idle. '''([[:Category:Frodo feature|Future Frodo addition]])'''<br /> |-{{frodo row}}<br /> | InhibitIdleShutdown(true/false)<br /> | Prevent the system to shutdown on idle. '''([[:Category:Frodo feature|Future Frodo addition]])'''<br /> |-<br /> | Resolution<br /> | Change XBMC's Resolution.<br /> |-<br /> | UpdateLibrary(database,[path])<br /> | Takes either &quot;video&quot; or &quot;music&quot; as a parameter to begin updating the corresponding database. For &quot;video&quot; you can additionally specify a specific path to be scanned.<br /> |-<br /> | CleanLibrary(database)<br /> | This funtion will perform a number of 'cleanup' tasks on your video database and can be run if you have moved, deleted or renamed files. Takes either &quot;video&quot; or &quot;music&quot; as a parameter to begin cleaning the corresponding database.<br /> |-<br /> | PageDown<br /> | Send a page down event to the pagecontrol with given id.<br /> |-<br /> | PageUp<br /> | Send a page up event to the pagecontrol with given id.<br /> |-{{frodo row}}<br /> | &lt;s&gt;LastFM.Love&lt;/s&gt;<br /> | &lt;s&gt;All songs that can be submitted to Last.fm can be loved, optional parameter (false) = direct loving without confirmationdialog.&lt;/s&gt; '''([[:Category:Frodo feature|Future Frodo removal]])'''<br /> |-{{frodo row}}<br /> | &lt;s&gt;LastFM.Ban&lt;/s&gt;<br /> | &lt;s&gt;Only songs that are playing on last.fm radio can be banned, optional parameter (false) = direct banning without confirmationdialog.&lt;/s&gt; '''([[:Category:Frodo feature|Future Frodo removal]])''' <br /> |-<br /> | Container.Refresh<br /> | Refresh current listing.<br /> |-<br /> | Container.Update<br /> | Update current listing. Send Container.Update(path,replace) to reset the path history.<br /> |-<br /> | Container.SetViewMode(id)<br /> | Set the current view mode (list, icons etc.) to the given container id.<br /> |-<br /> | Container.NextViewMode<br /> | Select the next view mode.<br /> |-<br /> | Container.PreviousViewMode<br /> | Select the previous view mode.<br /> |-<br /> | Container.SetViewMode<br /> | Move to the view with the given id.<br /> |-<br /> | Container.NextSortMethod<br /> | Change to the next sort method.<br /> |-<br /> | Container.PreviousSortMethod<br /> | Change to the previous sort method.<br /> |-<br /> | Container.SetSortMethod<br /> | Change to the specified sort method.<br /> |-<br /> | Container.SortDirection<br /> | Toggle the sort direction.<br /> |- <br /> | Control.Move(id,offset)<br /> | Will make a Container with the &quot;id&quot; specified in the command move focus by &quot;offset&quot;.<br /> |- <br /> | Control.SetFocus(id,position)<br /> | Will make a list with the &quot;id&quot; specified in the command gain focus at &quot;position&quot; number in its list. Alias SetFocus(id,position)<br /> |- <br /> | Control.Message(id,message,[windowid])<br /> | Sends a given message to a control in a given window (or active window if omitted). Messages can be movedown, moveup, pagedown, pageup, click.<br /> |- <br /> | SendClick(windowid,id)<br /> | Sends a click to a control in a given window (or active window if omitted).<br /> |- <br /> | LoadProfile(profilename,[prompt])<br /> | Load the specified profile. If prompt is not specified, and a password would be required for the requested profile, this command will silently fail. If promp' is specified and a password is required, a password dialog will be shown.<br /> |- <br /> | SetProperty(key,value[,id])<br /> | Sets a window property for the current window (key,value), or the specified window (key,value,id).<br /> |- <br /> | ClearProperty(key[,id]) <br /> | Clears a window property for the current focused window/dialog(key), or the specified window (key,id).<br /> |- <br /> | PlayWith()<br /> | Play the selected item with the specified player core.<br /> |- <br /> | LIRC.Stop<br /> | Removes XBMC as a LIRC client.<br /> |- <br /> | LIRC.Start<br /> | Adds XBMC as a LIRC client.<br /> |- <br /> | LIRC.Send(command)<br /> | Sends a command to LIRC, syntax is the lirc protocol without the newline.&lt;br /&gt;Example: LIRC.Send(SEND_ONCE Onkyo_RC-453S2 volup)<br /> |- <br /> | LCD.Suspend<br /> | Suspends LCDproc.<br /> |- <br /> | LCD.Resume<br /> | Resumes LCDproc.<br /> |- <br /> | WakeOnLan(mac)<br /> | Sends the wake-up packet to the broadcast address for the specified MAC address (Format: FF:FF:FF:FF:FF:FF or FF-FF-FF-FF-FF-FF).<br /> |- <br /> | exportlibrary(music,false,filepath)<br /> | The music library will be exported to a single file stored at filepath location.<br /> |- <br /> | exportlibrary(video,true,thumbs,overwrite,actorthumbs)<br /> | The video library is exported to multiple files with the given options. Here thumbs, overwrite and actorthumbs are boolean values (true or false).<br /> |- <br /> | Addon.Default.OpenSettings <br /> | Open a settings dialog for the default addon of the given type<br /> |- <br /> | UpdateAddonRepos<br /> | Triggers a forced update of enabled add-on repositories.<br /> |- <br /> | UpdateLocalAddons<br /> | Triggers a scan of local add-on directories.<br /> |- <br /> | Weather.Refresh<br /> | Force weather data refresh<br /> |- <br /> | Weather.LocationNext<br /> | Switch to next weather location<br /> |- <br /> | Weather.LocationPrevious<br /> | Switch to previous weather location<br /> |- <br /> | Weather.LocationSet<br /> | Switch to given weather location (parameter can be 1-3)<br /> |- <br /> | VideoLibrary.Search<br /> | Brings up a search dialog which will search the library<br /> |}<br /> <br /> <br /> [[Category:XBMC Manual]]<br /> [[Category:Python]]<br /> [[Category:Addon Development]]<br /> [[Category:Skin Development]]</div>

Schapplm https://kodi.wiki/index.php?title=NFS&diff=63997 2013-09-04T17:31:15Z

<p>Schapplm: /* Synology */</p> <hr /> <div>&lt;section begin=&quot;intro&quot;/&gt;'''Network File System''', or '''[http://en.wikipedia.org/wiki/Network_File_System_%28protocol%29 NFS]''', is a way to share folders over a network, and was added to XBMC in v11 (Eden). The main benefits of using NFS instead of SMB are its low protocol overhead (which allows it to send data across a network more quickly) and its use of simple [http://en.wikipedia.org/wiki/User_identifier UID's] to authenticate users rather than username/password combinations. This part bears repeating, as many people are confused on this point and try to create usernames and passwords to get XBMC to work with NFS: '''NFS does not use usernames or passwords as logins;''' it uses a UNIX-based &quot;userID&quot; (UID) alone.&lt;section end=&quot;intro&quot;/&gt;<br /> <br /> NFS's main disadvantage in comparison to SMB (a commonly-encountered protocol in Windows environments) is that it can be more complicated to set up in some cases, since many non-technical users are unfamiliar with configuring UNIX-based protocols.<br /> <br /> NFS is commonly found on all Linux/UNIX distributions, as well as on OS X and Solaris, and offers several features:<br /> :* It is already incorporated in UNIX-like operating systems (such as OS X), eliminating the need for additional software and services to be installed on your computer.<br /> :* It allows for authentication by UID, thus eliminating the need to save usernames and passwords in XBMC source XML files (note, however, that this simple authentication also makes it more vulnerable to attacks; NFS should be only used inside a private LAN).<br /> :* Once properly configured, NFS will allow your network shares to be seen and accessed by not only XBMC, but also any other machine on your network.<br /> <br /> ;{{note|If you already have a working NFS server check that the export options required by XBMC have been set (as described in the relevant section below).}} <br /> <br /> When configuring NFS shares to use as network sources for XBMC's music/video libraries, use the following format: '''nfs://1.2.3.4/path/to/folder''' (where &quot;1.2.3.4&quot; should be replaced with the IP of your NFS server, and &quot;/path/to/folder&quot; should be replaced with the path to the folder you want to share; a double slash between the server and the path is wrong, you '''should not''' use nfs://1.2.3.4//path/to/folder). See the sections below for help configuring NFS shares on various devices' operating systems.<br /> <br /> For more info on network sources for your music and video in XBMC, see [[Types of Media Sources]].&lt;br /&gt;<br /> <br /> <br /> == NFS sharing from Windows ==<br /> Windows does not have any built-in native ability to share folders via NFS; and only a limited selection of Windows operating systems have the native ability to access NFS shares as a client. However, several third-party solutions attempt to provide NFS functionality, on both the server side and the client side.<br /> <br /> For ''serving'' (sharing) files from Windows using NFS, there seem to be three choices:<br /> :* Windows Server 2003 R2 and Windows Server 2008 have built-in NFS Server and Client through Subsystem for UNIX-based Applications (SUA). With 64-bit support, this solution supports files up to 4TB in size<br /> :* [http://en.wikipedia.org/wiki/Microsoft_Windows_Services_for_UNIX Microsoft Windows Services for UNIX (SFU)] available [http://www.microsoft.com/download/en/details.aspx?id=274 here]for Windows 2000, Windows XP Professional (NOT Home edition, without a [http://www.networkedmediatank.com/showthread.php?tid=1434 hexedit hack]), Windows 2003 Server, and Windows Home Server (based on 2003 Server). SFU is 32-bit only, which ''may'' mean it only supports files up to 2GB in size, [http://www.suacommunity.com/SUA_Tools_Env_Start.htm#_Toc203389873 according to some sources] (this is unconfirmed). A good installation guide can be found [http://www.networkedmediatank.com/showthread.php?tid=1434 here]. Windows SFU will not install on Windows Vista or Windows 7, so there is no way to ''serve'' NFS from Windows Vista or Windows 7 with the possible exception of the haneWIN solution below, but it is unconfirmed if that works with Windows Vista/7.<br /> :* [http://www.hanewin.net/nfs-e.htm haneWIN NFS Server for Windows] - a shareware program that costs 19EUR for non-commercial use. Claims to work for &quot;Windows 2000 and above.&quot;<br /> <br /> == NFS sharing from OS X ==<br /> {{see also|NFS Manager}}<br /> NFS is built into Mac OS X (OS 10.5 and later), and thus no additional software is required to set up NFS shares on a Mac OS X device.<br /> <br /> ;{{note|The following assumes some basic knowledge of the UNIX/BSD operating system interface and environment, and assumes you are familiar with using a Mac's Terminal command-line utility. It also assumes you have a beginner's understanding of UNIX text editors such as [http://mintaka.sdsu.edu/reu/nano.html nano] or [http://www.eng.hawaii.edu/Tutor/vi.html vi].}}<br /> <br /> 1. To allow regular (non-root) users to connect to your NFS shared folders, you'll need to edit the &quot;/System/Library/LaunchDaemons/com.apple.nfsd.plist&quot; file. Open it and add the option &quot;-N&quot; to the startup parameters as follows: <br /> <br /> &lt;array&gt;<br /> &lt;string&gt;/sbin/nfsd&lt;/string&gt;<br /> '''&lt;string&gt;-N&lt;/string&gt;'''<br /> &lt;/array&gt;<br /> <br /> If you don't do this step, XBMC will only be able to access the Mac's shared NFS folders if XBMC is running as root (normally, XBMC does not run as root, so you will almost certainly want to do this first step and add the -N parameter).<br /> <br /> 2. The NFS server and its shared folders are set up in a config file named &quot;exports&quot;, located in the /etc directory. Technically speaking, with NFS you &quot;export a path&quot; rather than &quot;share a folder&quot; (which is why the file is named &quot;exports&quot;), but we'll use the latter phrasing for simplicity's sake.<br /> <br /> The /etc/exports file may not yet exist; if not, you'll need to create it. The file is edited either manually (in Terminal, using a UNIX text editor such as '''nano''' or '''vi''') or via a GUI utility, the most well-known of which is [http://www.bresink.com/osx/NFSManager.html NFS Manager]. The following guide assumes you are using Terminal (if using NFS Manager, consult that software's documentation for help).<br /> <br /> To view the current contents of /etc/exports, if any, execute the following command in a Terminal window:<br /> <br /> '''cat /etc/exports'''<br /> <br /> Any folders to be shared via NFS should be listed on separate lines, along with any configuration parameters governing connections to those folders. The lines should follow this general format:<br /> <br /> /path/to/folder_name_to_share [-parameter1 -parameter2 ...] &lt;IP address restriction (optional)&gt;<br /> <br /> &lt;big&gt;Examples&lt;/big&gt;<br /> <br /> In this sample /etc/exports file, we've set up four folders to be shared via NFS, using various parameters and options. The folders are all contained in a folder called &quot;nfs_shares&quot;, and are named to indicate some things about how we've set them up; obviously, on your system, the folder names would be things like &quot;video&quot;, &quot;music&quot;, and so on.<br /> <br /> /nfs_shares/allread -ro -mapall=nobody -alldirs<br /> /nfs_shares/allwrite -mapall=nobody -alldirs -network 192.168.1.0 -mask 255.255.255.0<br /> /nfs_shares/writeAs501 -mapall=501 -alldirs 192.168.1.5<br /> /nfs_shares/xbmcuser<br /> <br /> Let's look at what each of these shared folder configurations means.<br /> <br /> * The folder &quot;'''/nfs_shares/allread'''&quot; can be accessed from all computers (because no IP address is given), is read-only (&quot;'''-ro'''&quot;), and all incoming connections are assigned the same permissions as the UNIX user &quot;nobody&quot;, who has anonymous access (&quot;'''-mapall=nobody'''&quot;). This last parameter ensures that anyone can access the folder, but they will not have any rights on your NFS server other than those belonging to the &quot;nobody&quot; user. Also, the &quot;'''-alldirs'''&quot; parameter is used to indicate that incoming connections can mount either the /allread folder OR any subfolder underneath /allread.<br /> <br /> * The folder &quot;'''/nfs_shares/allwrite'''&quot; can be accessed from all computers on the subnet 192.168.1.0/255.255.255.0, has read and write permissions (we've omitted &quot;'''-ro'''&quot;), and again access rights for user &quot;nobody&quot; are assigned (&quot;'''-mapall=nobody'''&quot;). The &quot;'''-alldirs'''&quot; parameter is once again used to allow subfolders to be mounted directly.<br /> <br /> * The folder &quot;'''/nfs_shares/writeAs501'''&quot; can be accessed from the computer with an IP of 192.168.1.5, has read and write permissions (again we've omitted &quot;'''-ro'''&quot;), and access rights belonging to users on your system with a UID of 501 (see note below) will be inherited by all incoming connections ('''-mapall=501'''). The &quot;'''-alldirs'''&quot; parameter is once again used to allow subfolders to be mounted directly.<br /> <br /> :;{{note|As already mentioned, authentication to the NFS server is done by checking UIDs. For XBMC, this means that the UID which the XBMC process is running under is given to the NFS server to be authenticated. To find out your current UID, just type &quot;id&quot; into a console:}}<br /> <br /> Mac:~ [''your_user_name'']$ '''id'''<br /> <br /> ::You should see something that begins like this:<br /> <br /> uid=501(''your_user_name'')<br /> <br /> :In this example, my UID is 501. If you are going to be connecting to your NFS shared folder from XBMC on iOS, keep in mind that on iOS XBMC runs as the user &quot;mobile&quot;, which should have UID 501 also. <br /> <br /> * The folder &quot;'''/nfs_shares/xbmcuser'''&quot; can be accessed from all computers ('''no ip given'''), readwrite (no &quot;'''-ro'''&quot;) and the access rights belonging to the UID which is connecting to the NFS server are used (&quot;'''-mapall'''&quot; removed). <br /> ;{{note|The important effect of the absence of the -mapall parameter in this case: if someone connects to your NFS server as root, they will be running on your system as root! Also note that because &quot;-alldirs&quot; is not specified, incoming connections will only be able to connect to the /xbmcuser folder, NOT any folders underneath it.}}<br /> <br /> Bear in mind that any UID's that are used to connect to the NFS server, or that are specified with &quot;-mapall&quot;, have to exist on your NFS server (i.e. on your Mac).<br /> <br /> '''Each change on the exports config file needs a restart of the nfs server! Just issue &quot;sudo nfsd restart&quot; for this.'''<br /> <br /> 3. Once you've configured and saved your /etc/exports file, the NFS server can be started either by rebooting or by executing the following command:<br /> <br /> $ sudo nfsd start<br /> <br /> === Troubleshooting NFS on OS X ===<br /> <br /> ==== -N flag is set, but shares still won’t work ====<br /> <br /> Sometimes there are issues with NFS shares on OS X. Most of them result in the &lt;code&gt;-N&lt;/code&gt; flag not being set, but they result in different error messages or issues. One of the root issues is the flag being set in the Property List file, but not read by launchd which controls the process. The following observations are pretty common in this case and if you see one of these points, it won’t hurt to either inspect the nfsd process on your Mac or restart the whole computer.<br /> <br /> * You have successfully shared the volume and you can mount it from other Macs in your network (via ⌘K in the Finder), but not from XBMC.<br /> * You can add the computer share (e.g. &lt;code&gt;nfs://192.168.1.5/&lt;/code&gt;), but not the share that contains a path (e.g. &lt;code&gt;nfs://192.168.1.5/nfs_shares/allread&lt;/code&gt;).<br /> * When you add the computer share, you can enter it in XBMC’s browser, but then clicking on one of the mount points does nothing.<br /> * You see either '''&quot;Server responded: Procedure not available&quot;''' or '''&quot;RPC Packet not accepted by the server&quot;''' in the error logs.<br /> <br /> In most cases it’s sufficient to restart nfsd via launchd, just killing the process with &lt;code&gt;kill -9&lt;/code&gt; or &lt;code&gt;killall nfsd&lt;/code&gt; after applying changes to the Property List file has no effects. To restart nfsd via launchd you have to type the following command in the Terminal:<br /> <br /> sudo launchctl unload /System/Library/LaunchDaemons/com.apple.nfsd.plist &amp;&amp; \<br /> sudo launchctl load /System/Library/LaunchDaemons/com.apple.nfsd.plist<br /> <br /> When you use &lt;code&gt;ps&lt;/code&gt; to inspect the process, &lt;code&gt;-N&lt;/code&gt; should be visible at the end of the line. If it’s not, then launchd didn’t apply the changes and just (re-)started nfsd with the old configuration. A proper output looks like this:<br /> <br /> ~ '''ps aux | grep nfsd'''<br /> root 55828 0,0 0,0 2500812 2332 ?? Ss 3:54pm 0:08.96 /sbin/nfsd '''-N'''<br /> chiefsucker 58788 0,0 0,0 2435268 496 s000 U+ 7:22pm 0:00.00 grep nfsd<br /> <br /> Pay attention to the &lt;code&gt;-N&lt;/code&gt; flag being visible in the ps output. If the &lt;code&gt;-N&lt;/code&gt; flag is visible, but your shares don’t work, then it’s probably another issue.<br /> <br /> ==== NFS shares stopped working after OS X upgrade ====<br /> <br /> If your share stopped working after you upgraded your OS (e.g. from Lion to Mountain Lion) then it usually means that the installer did overwrite the Property List file and you have to add &lt;code&gt;-N&lt;/code&gt; again.<br /> <br /> ==== My Mac goes to sleep while playing a movie from a NFS share ====<br /> <br /> OS X 10.8 Mountain Lion introduced some changes that result in very aggressive sleep behaviour. Because NFS shares aren’t handled and treated like shares set from within the Sharing panel in System Preferences, OS X will ignore clients that access your NFS shares and just put it to sleep. Fortunately there are some workarounds:<br /> <br /> # Set '''Computer sleep''' in the Energy Saver pane of System Preferences to '''Never'''. Unfortunately this will affect the whole machine and you’ll have to put your Mac manually to sleep from now on.<br /> # Get the [http://itunes.apple.com/app/caffeine/id411246225?mt=12 free Caffeine app from the Mac App Store]. The app will reside in your menu bar and you can prevent your Mac from sleeping with just one mouse-click. If you disable Caffeine (again with one click), your Mac will go to sleep as set in the System Preferences. This has the benefit of adjustable sleep behavior, i.e. you turn Caffeine on when you watch movies and you turn it off otherwise to preserve energy and save the planet.<br /> # You can reach the same goal with the Terminal app &lt;code&gt;caffeinate&lt;/code&gt; that gets shipped with the OS since OS X 10.8 Mountain Lion.<br /> <br /> == NFS sharing from Linux ==<br /> <br /> NFS sharing has been built into linux kernel for a long time.<br /> <br /> ;{{note|This article assumes some basic knowledge of the Linux/UNIX/BSD operating-system interface and environment.}}<br /> <br /> The configuration of the NFS server takes place in the config file &quot;/etc/exports&quot;. As already mentioned, the authentication to the NFS server is done through UIDs. For XBMC, this means the UID that the XBMC process is running under is used to authenticate on the NFS server. To find out what UID XBMC is using, just type &quot;id&quot; into a console:<br /> <br /> penix:~ [your_user_name]$ id<br /> uid=501(your_user_name)<br /> <br /> In this example, my UID is 501. For iOS devices, keep in mind that XBMC is running as the user &quot;mobile&quot;, whose UID should also be 501.<br /> <br /> A basic configuration for exporting a path with NFS looks like this:<br /> <br /> /nfs/export &lt;ip or iprange which is allowed to connect&gt;(rw,all_squash,insecure)<br /> <br /> The important options here for use with XBMC are the &quot;ip or iprange&quot; and the &quot;insecure&quot; options. The &quot;insecure&quot; option is needed because we want to be able to run XBMC without root privileges. If the insecure option is not enabled, only the root user (uid 0) will have access to the nfs share. The &quot;ip or iprange&quot; specifies which hosts on the network will be allowed to access the exported NFS share. <br /> <br /> By changing some of the options of that line, we can use any of three different approaches for getting the access rights configured as we want:<br /> <br /> 1. The option all_squash (most insecure) - all UIDs connected to the NFS server are mapped to UID 65534 (user nobody)<br /> ::* In this case all files which shall be accessed on the NFS exported path should have the correct rights for the user &quot;nobody&quot;.<br /> 2. Using the option &quot;all_squash&quot; in conjunction with the option &quot;anonuid&quot; and &quot;anongid&quot;<br /> ::* By adding the options &quot;anonuid=501&quot; and &quot;anongid=501&quot; all accesses would be mapped to the user with UID 501 (user &quot;mobile&quot; on iOS or user &quot;memphis&quot; in my example above)<br /> 3. Removing the &quot;all_squash&quot; option the accesses will be done with the UID given from the user which is running XBMC<br /> ::* So if XBMC is started with username foobar (which has UID 1000) all accesses to the NFS export path will be made with UID 1000.<br /> <br /> &lt;big&gt;Examples for exported paths:&lt;/big&gt;<br /> ### access from ''all computers'' (&quot;'''*'''&quot;), ''readonly'' (&quot;'''ro'''&quot;), access for user ''nobody'' (&quot;'''all_squash'''&quot;)<br /> /nfs/allread *(ro,all_squash,insecure)<br /> <br /> ### access from the subnet 192.168.1.0/255.255.255.0, ''read/write'' (&quot;'''rw'''&quot;), access for user ''nobody''<br /> ### (&quot;'''all_squash'''&quot;). Remember that &quot;'''rw'''&quot; doesn't automatically allow writes; the user &quot;nobody&quot; must<br /> ### have write access to the path on the filesystem.<br /> /nfs/allwrite 192.168.1.0/24(rw,all_squash,insecure)<br /> <br /> ### access from 192.168.1.5, ''read/write'' (&quot;'''rw'''&quot;), access for user with UID 501 (i.e. memphis, for me)<br /> ### (&quot;'''all_squash,anonuid=501,anongid=501'''&quot;)<br /> /nfs/writeAsMemphis 192.168.1.5(rw,all_squash,insecure,anonuid=501,anongid=501)<br /> <br /> ### access from ''all computers'' (&quot;'''*'''&quot;), ''read/write'' (&quot;'''rw'''&quot;), access for the UID connecting to the<br /> ### NFS server (&quot;'''all_squash'''&quot; removed)<br /> /nfs/xbmcuser *(rw,insecure)<br /> <br /> ### NTFS export *SECURITY Warning: this gives the user ROOT access*<br /> ### access from the subnet 192.168.1.0/255.255.255.0, ''read/write'' (&quot;'''rw'''&quot;), nfs client connects<br /> ### as root (&quot;'''no_root_squash'''&quot;). Otherwise, permission is for ''nfsnobody'', (uid 65534).<br /> ### NTFS is non-POSIX permissions compliant, so you must access the share as ''root''<br /> /nfs/NTFS_share 192.168.1.0/24(rw,'''no_root_squash''',insecure)<br /> <br /> <br /> The UIDs which are used to connect to the NFS server or which are specified with &quot;anonuid&quot; and &quot;anongid&quot; have to exist on the NFS server. Otherwise the filesystem permission can't be set.<br /> <br /> Remember - access rights are these you give in the filesystem. '''After each change to the exports config file issue &quot;sudo exportfs -ra&quot;!'''<br /> <br /> == NFS sharing from NAS4Free 9.x (successor to legacy FreeNAS 7.x) ==<br /> The information in the Linux section above also applies for *BSD based systems (such as FreeBSD). This section addresses some specific issues to bear in mind if you are using NAS4Free 9.x or FreeNAS 7.x (aka. legacy) installations.<br /> <br /> ;{{note|FREENAS 8.3.0-RELEASE or later does not require modifying the rc.conf file for XBMC to access NFS shares. You must however enable &quot;allow non-root mount&quot; which can be found under the SERVICES - NFS section in the Freenas 8.3.0 web GUI.}}<br /> <br /> Setup your NFS shares as normal. Remember: don't create shares inside other shares. The following would be illegal...<br /> /mnt/disk -alldirs,quiet -mapall=root -network 192.168.1.0 -mask 255.255.255.0<br /> /mnt/disk/folder -alldirs,quiet -mapall=root -network 192.168.1.0 -mask 255.255.255.0<br /> ...because the &quot;/mnt/disk/folder&quot; directory is already shared by &quot;/mnt/disk&quot;. If you remember to set the setting &quot;All dirs&quot; when creating your NFS shares, the flag &quot;-alldirs&quot; will be set. This flag allows you to mount any subdirectory of your share just as if it was a share itself. Said another way: It's not necessary to share &quot;/mnt/disk/folder&quot; because you can mount it through the &quot;/mnt/disk&quot; share.<br /> <br /> After having set up a standard NFS share on your NAS4Free box, you need to add a few variables to rc.conf on NAS4Free. This is done by going into System &gt; Advanced &gt; rc.conf .<br /> Here you need to add the following:<br /> Variable Value Comment<br /> mountd_flags -n Allow non-root mount requests to be served. <br /> nfs_reserved_port_only NO Allow for insecure ports to be used by NFS. <br /> nfs_server_flags -u -t -n 4 Serve UDP and TCP with 4 servers. <br /> <br /> After this, apply your changes and reboot NAS4Free. You should now be able to mount your NFS shares, as well as any subdirectory of those shares.<br /> <br /> == NFS sharing from ZFSGuru ==<br /> Very similar to FreeNAS solution.<br /> mountd needs the -n flag.<br /> In ZFSGuru you can achieve this by adding<br /> weak_mountd_authentication=&quot;YES&quot;<br /> to /etc/rc.conf<br /> <br /> == NFS sharing from commercial NAS systems such as Synology or QNAP ==<br /> Each NAS manufacturer, if it allows you to share folders via NFS on its NAS systems, does so in its own way. Often this will involve setup via the NAS's control panel or administrator interface. You can also connect to many NAS systems via ssh and manually edit files in order to set up and configure NFS (consult your NAS manual to see if this is possible/desirable/necessary). Since most NAS systems are based on Linux/UNIX, if you need to manually edit files, you should be able to make use of the [[#NFS sharing from Linux|Linux instructions above]] to create/edit your NFS shares.<br /> <br /> === Troubleshooting NFS on a commercial NAS with XBMC ===<br /> Your NFS server on your NAS needs to be able to allow connections on so-called '''unprivileged ports''', which are port numbers higher than 1023. However, most NAS's are set up by default to deny incoming NFS connections on these unprivileged ports. This is one of the most common reasons why XBMC users experience problems when trying to connect to an NFS shared folder on a NAS.<br /> <br /> If you are having trouble connecting to your NFS shares on your NAS from XBMC, make sure your NFS shares have the &quot;insecure&quot; option enabled, which will allow connections on unprivileged ports. To check, connect to your NAS via ssh and issue the '''cat /etc/exports''' command. Your shared folders will each have several parameters listed separated by commas. If the &quot;insecure&quot; parameter is not listed, you will need to add that parameter to the list. This will usually involve directly editing the /etc/exports file with a UNIX text editor and adding the &quot;insecure&quot; option manually, although some NAS's may offer the ability to add the option via an admin interface. Check your NAS manual for details, or explore the section below if your brand of NAS is listed.<br /> <br /> === Commercial NAS NFS setup instructions ===<br /> XBMC users have contributed the following NFS setup instructions for various brands of NAS devices. If your NAS is listed below, feel free to follow the accompanying instructions to set up NFS on your system.<br /> <br /> ==== Synology ====<br /> [[File:Synology.png|link=]]&lt;br /&gt;<br /> ;{{note|You do not need to create a special user account on your Synology NAS in order to make use of NFS for XBMC. The following guide assumes you are comfortable with using the simplest (least secure) internal setup on your NAS, which will normally be the case for the vast majority of XBMC users.}}<br /> <br /> &lt;gallery widths=600px heights=340px&gt;<br /> File:Step1.png|'''&lt;big&gt;Step 1:&lt;/big&gt;''' Log in to your Synology admin control panel.<br /> File:Step2.png|'''&lt;big&gt;Step 2:&lt;/big&gt;''' Enable SSH (if not enabled already): Control Panel --&gt; Terminal --&gt; Enable SSH service --&gt; {{button|OK}}<br /> <br /> File:Step3.png|'''&lt;big&gt;Step 3:&lt;/big&gt;''' Enable NFS under Control Panel --&gt; Win/MAC/NFS<br /> File:Step4.png|'''&lt;big&gt;Step 4:&lt;/big&gt;''' NFS Services --&gt; Enable NFS --&gt; {{button|OK}}<br /> <br /> File:Step5.png|'''&lt;big&gt;Step 4:&lt;/big&gt;''' Under Control Panel --&gt; Shared Folder<br /> File:Step6.png|'''&lt;big&gt;Step 6:&lt;/big&gt;''' On NFS Privileges tab select entry for the folders you want to share e.g. '''Movies'''<br /> File:Step7.png|'''&lt;big&gt;Step 7:&lt;/big&gt;''' {{button|Create}} privileges for the selected share<br /> File:Step8.png|'''&lt;big&gt;Step 8:&lt;/big&gt;''' As per example allow all IPs (or the desired IP for your HTPC) with '''read/write''' permissions with no mapping and enable '''asynchronous'''. The option to '''allow connections from non-priviledged hosts''' is new in DSM version 4.3-3776. With this option the following steps 10 to 14 are no longer needed. --&gt; {{button|OK}}<br /> File:Step9.png|'''&lt;big&gt;Step 9:&lt;/big&gt;''' Press {{button|OK}}<br /> &lt;/gallery&gt;<br /> <br /> 10. On your computer, in a command line window (Terminal on a Mac, CMD on a Windows PC, etc), ssh into your Synology:<br /> '''ssh root@&lt;&lt;YOUR.SYNOLOGY.IP.ADDRESS&gt;&gt;'''<br /> 11. Type in '''cat /etc/exports''' to make sure your previous steps have created exported NFS directories. If no entries are found, go back to the previous steps and make sure you've followed them correctly. You should be seeing something like this:<br /> <br /> [[File:Step11.png|600px]]<br /> <br /> 12. Type '''vi /etc/exports''' to edit the /etc/exports file, and change all the &quot;insecure_locks&quot; entries to simply read &quot;insecure&quot;. If you don't know vi: press the INS[SERT] key, use arrows to go to the line to edit, and delete/edit the line. Then press the ESC key, and type ''':x''' to 'Save &amp; Exit'.&lt;br /&gt;<br /> 13. Type '''cat /etc/exports''' again, and you should now see something like this (make sure it says &quot;insecure&quot; rather than &quot;insecure_locks&quot;):<br /> <br /> [[File:Step15.png|600px]]<br /> <br /> <br /> 14. Type '''exportfs -ra''' to initialize your newly exported directories, or reboot the NAS.&lt;br /&gt;<br /> 15. You should now be able to browse NFS and get to your exported Synology subfolders in XBMC.&lt;br /&gt;<br /> <br /> ==== QNAP ====<br /> [[File:QNAP.gif|link=]]&lt;br /&gt;<br /> ;{{note|You do not need to create a special user account on your QNAP NAS in order to make use of NFS for XBMC. The following guide assumes you are comfortable with using the simplest (least secure) internal setup on your NAS, which will normally be the case for the vast majority of XBMC users.}}<br /> <br /> This guide requires you to [[SSH]] into your QNAP, and also to use the terminal editor [http://en.wikipedia.org/wiki/Vi Vi] to edit files.<br /> <br /> Here's a couple of guides if you wish to learn more, but feel free to google for further reading: <br /> <br /> [http://www.tuxfiles.org/linuxhelp/vimcheat.html Vi Cheat Sheet]<br /> <br /> 1. Log into your QNAP admin control panel. (Web browser = IP-ADDRESS:8080).<br /> <br /> &lt;gallery widths=700px heights=340px&gt;<br /> File:QNAP_SSH.png|'''&lt;big&gt;Step 2:&lt;/big&gt;''' Enable SSH (if not already): Network Services -&gt; Telnet / SSH -&gt; 'tick' Allow SSH connection, Press {{button|Apply}}<br /> File:QNAP_NFS.png|'''&lt;big&gt;Step 3:&lt;/big&gt;''' Enable NFS: Network Services -&gt; NFS Service -&gt; 'tick' Enable NFS Service, Press {{button|Apply}}<br /> &lt;/gallery&gt;<br /> &lt;gallery widths=600px heights=350px&gt;<br /> File:QNAP_Shares.png|'''&lt;big&gt;Step 3:&lt;/big&gt;''' Set NFS Access Rights: Under &quot;Enable NFS Service&quot; Click on &quot;Click here to set the NFS access right of the network share&quot;<br /> File:QNAP_NFS_Access.png|'''&lt;big&gt;Step 4:&lt;/big&gt;''' Click on the NFS icon next to Qmultimedia (or whatever the name of your media share on the QNAP) and set Access Right to No Limit and put in the IP Address of each individual device that requires NFS connection (ATV2, Desktop, Laptop, etc.), Press {{button|Apply}}<br /> &lt;/gallery&gt;<br /> <br /> 6. On your computer, in a command line window (Terminal on a Mac, CMD on a Windows PC, etc), ssh into your QNAP:<br /> '''ssh admin@&lt;&lt;YOUR QNAP IP ADDRESS&gt;&gt;'''<br /> <br /> 7. Type in '''cat /etc/exports''' to make sure your previous steps have created exported NFS directories. If no entries are found, go back to the previous steps and make sure you've followed them correctly. You should be seeing something like this:<br /> &quot;/share/MD0_DATA/Qmultimedia&quot; 192.168.1.15(rw,async,no_root_squash) 192.168.1.20(rw,async,no_root_squash) <br /> &quot;/share/NFS/Qmultimedia&quot; 192.168.1.15(rw,nohide,async,no_root_squash) 192.168.1.20(rw,nohide,async,no_root_squash)<br /> <br /> 8. Type '''vi /etc/exports''' to edit the /etc/exports file, and add &quot;insecure&quot; entries inside the brackets in front &quot;rw&quot;(separated with a comma &quot;,&quot;). If you don't know vi: press the &quot;i&quot; key, use arrows to go to the line to edit, and add the entries. Then press the ESC key, and type ''':wq''' to 'Save &amp; Exit'. Your exports file should now look something like this:<br /> &quot;/share/MD0_DATA/Qmultimedia&quot; 192.168.1.15(insecure,rw,async,no_root_squash) 192.168.1.20(insecure,rw,async,no_root_squash) <br /> &quot;/share/NFS/Qmultimedia&quot; 192.168.1.15(insecure,rw,nohide,async,no_root_squash) 192.168.1.20(insecure,rw,nohide,async,no_root_squash)<br /> <br /> 9. Type '''exportfs -ra''' to initialize your newly exported directories, &lt;span style=&quot;color:#FF0000&quot;&gt;'''DO NOT''' reboot the QNAP or restart NFS via the QNAP Admin page - If you do the QNAP will overwrite the changes you just made&lt;/span&gt;.<br /> <br /> &lt;gallery widths=415px heights=168px&gt;<br /> File:QNAP_nfssetting_before.png|'''&lt;big&gt;Step 10:&lt;/big&gt;''' Now type '''vi /etc/config/nfssetting'''. You'll see something like this:<br /> File:QNAP_nfssetting_after.png‎|'''&lt;big&gt;Step 11:&lt;/big&gt;'''Move your cursor to after the '''rw''' in the line '''/share/*****/Qmultimedia = rw''' (***** interchangeable with whatever yours says). Press {{keypress|i}} and add '''insecure''' separated by a ''',''' (comma). When you're done editing press {{keypress|esc}} and then ''':wq''' to save the changes and close the file. It will look something like this when finished:<br /> &lt;/gallery&gt;<br /> &lt;span style=&quot;color:#FF0000&quot;&gt;'''CAUTION: If you reboot your QNAP NAS at any time after completing the steps above, but before completing the steps below, the changes you've made will be wiped out and you will need to redo the process.'''&lt;/span&gt;<br /> <br /> 12. That should be it for getting it working.. You should now be able to browse NFS and get to your exported QNAP folders in XBMC. Now there's just a few more steps to ensure all your hard work survives a reboot/firmware upgrade.<br /> <br /> * We're going to edit/create an autorun script that overwrites two files from backups we're going to make.<br /> <br /> 13. Okay, you need to make a folder to store the backup files. You need to use the absolute path in the Autorun script. Type '''mkdir /share/MD0_DATA/backups''' and press '''enter'''. (The MD0_DATA part could be different on your model, I'm running a TS-509).<br /> <br /> 14. Now type '''cp /etc/exports /share/MD0_DATA/backups/exports''' and press enter.<br /> <br /> 15. Type '''cp /etc/config/nfssetting /share/MD0_DATA/backups/nfssetting''' and press enter.<br /> <br /> 16. Now for the fun part. To mount the ramblock follow the procedure below. This is based on the guide here (Method 1): [http://wiki.qnap.com/wiki/Running_Your_Own_Application_at_Startup QNAP Autorun Wikiguide] <br /> <br /> 17. Pick the method that is applicable to your QNAP model.<br /> ## Model TS-201: Mount the config ramblock /dev/mtdblock4: &lt;pre&gt;# mount -t ext2 /dev/mtdblock4 /tmp/config &lt;/pre&gt; <br /> ## Models TS-109, TS-109P, TS-110, TS-119, TS-209, TS-209P, TS-219, TS-409 (Marvell ARM), TS-419P: Mount the config ramblock /dev/mtdblock5: &lt;pre&gt;# mount -t ext2 /dev/mtdblock5 /tmp/config&lt;/pre&gt; <br /> ## Models TS-439, TS-509, TS-639, TS-809, TS-809U (x86): Mount the config ramblock /dev/sdx6: &lt;pre&gt;# mount -t ext2 /dev/sdx6 /tmp/config&lt;/pre&gt; <br /> # Create/Edit /tmp/config/autorun.sh .<br /> ## either using vi: &lt;pre&gt;# vi /tmp/config/autorun.sh&lt;/pre&gt;<br /> ### Get vi editor into edit mode: '''press i''' <br /> ### Add these lines to the autorun.sh script:<br /> ### '''cp /share/MD0_DATA/backups/exports /etc/exports'''<br /> ### '''cp /share/MD0_DATA/backups/nfssetting /etc/config/nfssetting'''<br /> ### Exit edit mode: '''press ESC''' <br /> ### Save and exit: ''':wq''' <br /> ## or editing it using a desktop PC and e.g. SFTP <br /> # Ensure that /tmp/config/autorun.sh is executable: &lt;pre&gt;# chmod +x /tmp/config/autorun.sh&lt;/pre&gt; <br /> # '''IMPORTANT:''' Unmount the mounted flash partition: &lt;pre&gt;# cd /&lt;/pre&gt; &lt;pre&gt;# umount /tmp/config&lt;/pre&gt;<br /> <br /> 18. Finish the linked guide, making sure to unmount the ramblock. (You will need to cd away from the /tmp/config directory to umount it.<br /> <br /> 19. Should be done!<br /> <br /> [[Category:File Sharing]]<br /> [[Category:Linux]]<br /> [[Category:Mac OS X]]<br /> [[Category:How-to]]<br /> {{frodo updated}}</div>

Schapplm https://kodi.wiki/index.php?title=File:Step8.png&diff=63996 2013-09-04T17:27:08Z

<p>Schapplm: Schapplm uploaded a new version of &amp;quot;File:Step8.png&amp;quot;: new option since DSM version 4.3-3776</p> <hr /> <div></div>

Schapplm