Add-on:PinSentry: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(Update Icon Link)
(Add initial settings section)
Line 4: Line 4:
|ID=script.pinsentry
|ID=script.pinsentry
|latest-version=1.0.0
|latest-version=1.0.0
|extension point=xbmc.python.pluginsource
|extension point=xbmc.python.script
|provides=
|provides=executable
|Summary=Protect Kodi Content With A Pin Code
|Summary=Protect Kodi Content With A Pin Code
|Description=Force users to enter the correct pin code for given content.
|Description=Force users to enter the correct pin code for given content.
Line 25: Line 25:


After install you first need to go to settings and select your pin, then enable which videos you want the pin to be displayed for (Either via Settings, Programs->PinSenty or Videos->Addons->PinSentry)
After install you first need to go to settings and select your pin, then enable which videos you want the pin to be displayed for (Either via Settings, Programs->PinSenty or Videos->Addons->PinSentry)
<br />
<br />
== Settings ==
This section details all the settings options for PinSentry
=== Setup===
{| border="0"
|- valign=top
|
:'''Pin Length'''
::The number of digits required when entering a pin
:'''Invalid Pin Notification'''
::How to inform the user that an invalid pin has been entered.  Options include "None", "Notification" and "Dialog"
:<u>'''''Operations'''''</u>
::
:'''Set Pin Value'''
::Sets the current pin
:'''Set Permissions'''
::Allows the setting of which items require the user to enter a pin before access.
:'''Clean Database'''
::Clears the database that contains all the rules for which items require a pin
| SCREEN SHOT COMING SOON
|}
=== Activity ===
{| border="0"
|- valign=top
|
:'''Video Playing'''
::Check if a pin is required each time a video is played
:'''Navigation'''
::Check if a pin is required to access certain menu items (Such as looking inside Movie Sets or TV Shows)
:'''Plugins'''
::Check if a pin is required to use a given plugin
:'''File Source'''
::Check if a pin is required when accessing soming using a give file source
:'''- Only Restrict File Sources During Navigation'''
::Only prompts for file source restrictions when navigating into one (Not when playing a video)
:'''Block Movies Without A Classification'''
::Requires a pin if an attempt to access a movie that has no valid classification set
:'''Block TV Shows Without A Classification'''
::Requires a pin if an attempt to access a TV Show that has no valid classification set
| SCREEN SHOT COMING SOON
|}
=== Advanced ===
{| border="0"
|- valign=top
|
:'''Remember Pin'''
::In the pin should be remembered after it has been entered. Options are Off, On (will be remembered until the screensaver starts or the system is restarted) and "For Time Period"
:'''- Remember Pin For (Minutes)'''
::If configured to remember the pin for a given time period, this sets that period (Between 1 and 120 minutes)
:'''Background'''
::What to display behind the pin dialog. Options are None (the default background will be visible), Black (the screen behind the dialog will be blacked out), PinSentry (the PinSentry fanart will be displayed) and Custom (a user defined image is used
:'''- Custom Background Image'''
::Allows the user to select their own background image
:'''Only Enforce Pin Between Set Times'''
::Will only prompt for a pin at certain times of the day
:'''- Start Time'''
::The time that the pin starts to be required
:'''- End Time'''
::The time that the pin is no longer required
:'''Highlight Videos Not Protected By Classifications'''
::If enabled, any you are using classification restrictions, will highlight the videos (with a play triangle) that are not currently protected with a pin in the "Set Permissions" menu
:<u>'''''Debugging'''''</u>
::
:'''Enable Debug logging'''
::Enables VideoScreensaver debug logging into the Kodi log file
| SCREEN SHOT COMING SOON
|}


<br />
<br />
Line 42: Line 114:
<br />
<br />
<br />
<br />
[[Category:Helix add-on repository]]

Revision as of 20:57, 11 June 2015

PinSentry
icon.png

Author: robwebset

Type: Program
Repo:

License: GPL v2.0
Source: Source code
Summary: Protect Kodi Content With A Pin Code
Home icon grey.png   ▶ Add-ons ▶ PinSentry
Attention talk.png Need help with this add-on? See here.

Force users to enter the correct pin code for given content.



Introduction

PinSentry is an addon that will allow you to set a pin code that you can then force to be input when you play a particular video file or navigate into a given TV Show or Plugin.

After install you first need to go to settings and select your pin, then enable which videos you want the pin to be displayed for (Either via Settings, Programs->PinSenty or Videos->Addons->PinSentry)



Settings

This section details all the settings options for PinSentry

Setup

Pin Length
The number of digits required when entering a pin
Invalid Pin Notification
How to inform the user that an invalid pin has been entered. Options include "None", "Notification" and "Dialog"
Operations
Set Pin Value
Sets the current pin
Set Permissions
Allows the setting of which items require the user to enter a pin before access.
Clean Database
Clears the database that contains all the rules for which items require a pin
SCREEN SHOT COMING SOON

Activity

Video Playing
Check if a pin is required each time a video is played
Navigation
Check if a pin is required to access certain menu items (Such as looking inside Movie Sets or TV Shows)
Plugins
Check if a pin is required to use a given plugin
File Source
Check if a pin is required when accessing soming using a give file source
- Only Restrict File Sources During Navigation
Only prompts for file source restrictions when navigating into one (Not when playing a video)
Block Movies Without A Classification
Requires a pin if an attempt to access a movie that has no valid classification set
Block TV Shows Without A Classification
Requires a pin if an attempt to access a TV Show that has no valid classification set
SCREEN SHOT COMING SOON

Advanced

Remember Pin
In the pin should be remembered after it has been entered. Options are Off, On (will be remembered until the screensaver starts or the system is restarted) and "For Time Period"
- Remember Pin For (Minutes)
If configured to remember the pin for a given time period, this sets that period (Between 1 and 120 minutes)
Background
What to display behind the pin dialog. Options are None (the default background will be visible), Black (the screen behind the dialog will be blacked out), PinSentry (the PinSentry fanart will be displayed) and Custom (a user defined image is used
- Custom Background Image
Allows the user to select their own background image
Only Enforce Pin Between Set Times
Will only prompt for a pin at certain times of the day
- Start Time
The time that the pin starts to be required
- End Time
The time that the pin is no longer required
Highlight Videos Not Protected By Classifications
If enabled, any you are using classification restrictions, will highlight the videos (with a play triangle) that are not currently protected with a pin in the "Set Permissions" menu
Debugging
Enable Debug logging
Enables VideoScreensaver debug logging into the Kodi log file
SCREEN SHOT COMING SOON



Debugging

If reporting a problem, please also provide a debug log. To do this you need to enable BOTH:

  • Kodi logging from the main setting menu
  • PinSentry debug from the PinSentry addon settings menu

Please do not paste the log into the forum thread, just link to it.

Donations

If you have found the PinSentry Addon useful and would like to help support future development and bug fixes, then please feel free to make a small donation.

Please use the link on the top of the PinSentry Forum