Join GitHub today
Table of Contents
You can install this addon from: URepo Repository
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. There is also an option to force the user to enter a pin when the system starts, and then restrict the amount of time the user is allowed each day.
After install you need to:
- Go to settings and select your pin
- Enable which videos you want the pin to be displayed for (Either via Settings, Programs->PinSenty or Videos->Addons->PinSentry)
Whenever a user selects an item that has been protected by PinSentry they will be prompted with a dialog like the following:
The correct pincode should be entered via the onscreen buttons or a remote control numeric pad in order to gain access. It you have "Allow Direction Keys In Pin Code" enabled in the settings then you can also use a pin code made up of Up, Down, Left and Right, this is useful if you have a remote control without numbers.
In order to configure which files or operations require the entry of the pin number you can access the menu be either via:
- Videos -> Addons -> PinSentry
- Programs -> PinSenty
That will allow you to set values as follows:
- Specify individual Movies to restrict
- Specify individual TV Shows to restrict
- Specify individual Movie Sets to restrict, this will also flag the movies in the movie set as restricted
- Specify individual Music Videos to restrict
- Specify individual Plugins to restrict
- Specify individual file sources to restrict
- Specify Movie or TV Show classification to restrict
- Specify repository to restrict
- Specify a PVR TV Channel to restrict
- Brings up the Pin Entry Dialog, forcing the pin to be entered before continuing
Each country has their own set of classifications, each meaning different things. Pin Sentry currently supports the following countries classifications
- South Korea
The classifications used on your Kodi library will depend on the settings (and scraper) that you used when you loaded them into the library initially. It is always worth noting that some videos can end up with incorrect classifications being set in your library.
There are two options in the PinSentry settings to help you identify videos that do not require a pin when using the current classification settings. Items that do not require a pin will be highlighted with the "Play Triangle" to illustrate that it can be played without a pin.
Videos that are protected via a classification rule can be excluded by manually selecting a given video and then choosing the "Remove Classification Restriction" option. Again, when this option is set it will be highlighted by the "Play Triangle".
If you wish to have multiple pins to restrict different types of content then you can enable this support via the options screen. You are allowed upto 5 different security levels, each needing a pin number to be set for them. (To access the settings screens the pin for the highest security level will be required).
The security levels are "stacked" on top of each other. You can set the security level of each video, you will then be prompted for a pin when you try and access the video, at which point you can enter a pin number. If you are trying to play a video with security level 3, then you can enter the pin number set for either 3, 4 or 5 in order to get it playing. Entering the pin for level 1 or 2 will continue to prevent you viewing the video.
If you enable the option "Show Security Level On Permissions Screen" then the security level will be shown on the permissions screens. This is shown in the format 01:00 (Level 1), 02:00 (Level 2), 03:00 (Level 3), 04:00 (Level 4) and 05:00 (Level 5). This is not ideal, but allows the use of the generic Kodi plugin screens without the need to introduce custom screens that would require support to be added for each skin.
If you wish to restrict the amount of time that a user is able to use Kodi each day (Children for example) then the Time Limits feature will allow you to do that. After being configured in the settings each time that Kodi starts it will prompt for a pin code to be entered.
If you enter the master (unrestricted) pin then no limits will be applied.
If you enter a users pin number then the current time limit settings (and remaining time) for that user will be displayed. The user will then be restricted to using Kodi within certain times of day and limited with regards to the total time that they can use Kodi each day.
If a user wishes to see how much time they have remaining, they can run PinSentry from the Programs menu and the summary dialog will be displayed again.
It is possible to have the Pin Prompt be displayed and not exit until the correct pin is entered. This can be started in one of the following ways:
- Videos -> Addons -> PinSentry -> [Force]
- As a screensaver - just select PinSentry as your screensaver, and the prompt will appear when your screensaver time expires
- On Kodi startup (Enable in settings)
SetProperty(PinSentryPrompt, true, 10000)
This section details all the settings options for PinSentry
The following is a list of known issues for which there is no fix possible:
- PVR TV Channels played on startup can sometimes (depending on the PVR backend used) play the video channel over the top of the PinSentry background image. (The Key entry screen is still visible).
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