/RpiKiosk_cli

Primary LanguageShellGNU General Public License v3.0GPL-3.0

<title>RpiKiosk_cli Version</title>

Creating Easy Digital Sign With Raspberry Pi 3 CLI Version

How To

***NOTE*** This tutorial is for the CLI Version of RpiKiosk.
These scripts and this tutorial were designed for use with a raspberry pi 2 or 3 with armhf architecture.
These scripts are based on the 2017-11-29-raspbian-stretch version of raspbian.

1. The first thing you will need to do is install Raspian onto your raspberry pi. To Install Raspian Stretch to your pi please go to https://www.raspberrypi.org/downloads/raspbian/ and follow the instructions there.

There are a few packages that these scripts do not directly depend on but will help the user should they want to make further changes. The RpiKioskInstall script will look for these and install them if they are not found on your pi. However, if you wish to install them before running the script then run the following commands on your pi in the terminal:

$ sudo apt-get update
$ sudo apt-get install git vim clutter

The "git" package is for users that are familiar with using git and want to clone the RpiKiosk Repository rather than downloading the zip file.
The "vim" package is simply a terminal text editor. This package is not crucial but will be of benefit if you are an advanced linux or pi user.
The "clutter" package will hide your pi's mouse cursor when it is not being used. This is good for locations that your kiosk or digital sign will not be within reach of public. In the case that your kiosk or digital sign is within reach of public, the RpiKioskCursorDisable script will allow you to completely disable your mouse cursor on your pi. (This can be reverted using the RpiKioskCursorEnable script)

2. Clone the RpiKiosk_cli from https://github.com/jharttech/RpiKiosk_cli.git with the following command:

$ git clone https://github.com/jharttech/RpiKiosk_cli.git

OR

Download the RpiKiosk_cli ZIP file from https://github.com/jharttech/RpiKiosk_cli/archive/master/zip to your pi, then extract the files using the following commands:

$ cd /path/to/downloaded/RpiKiosk_cli-master.zip
$ unzip RpiKiosk_cli-master.zip
$ mv RpiKiosk_cli-master /home/pi/RpiKiosk_cli

3. Go into the RpiKiosk_cli folder:

$ cd
$ cd RpiKiosk_cli

4. Run the Install script:

$ chmod +x KioskInstall.sh
$ ./KioskInstall.sh

This will start the Installation script and will walk you through the setup of your kiosk or digital sign. Simply follow the script and answer with the desired inputs. Once the script has finished you should restart your pi for the changes to take effect.

NOTES

I recommend you setting up a free Dakboard account at Dakboard.com. This company will help you quickly set up a nice digital display for free. (The free version is limited on customizations).

Screen Orientation:
This setting is dependant upon which way your digital sign (monitor or TV) is mounted. Your options are "Landscape" or "Portrait".

Enter your URL:
The KioskInstall script will ask you for a URL to your kiosk, video, or slideshow. If you are using DAKBoard, you will find this url under your account settings. It will be called your Private URL. If you are using google slides this will be your public published URL. This URL can be an URL to any type of legal media that you wish to display on your digital sign.

Mouse Cursor Disable:
The KioskInstall script will ask if you would like to disable your mouse cursor. If you choose to do so, you can revert this at a later time by running the "EnableCursor.sh" script in the RpiKiosk_cli folder. If you choose not to disable the mouse cursor during installation, you can disable it later by running the "DisableCursor" script found in the RpiKiosk_cli folder. The commands to run these scripts are:

$ cd /home/pi/RpiKiosk_cli
$ chmod +x EnableCursor.sh
$ ./EnableCursor

OR

$ cd /home/pi/RpiKiosk_cli
$ chmod +x DisableCursor
$ ./DisableCursor

Memory Split:
The KioskInstall script will ask if you would like to change the memory split of your pi. If you do not no what this means please indicate that you would not like to change this value by entering "NO" when prompted. You can change this later by running:

$ raspi-config

How to get to the terminal once you have installed the kiosk:
You may want to run other scripts or exit out of your newely created Kiosk. To do this on your pi, press the "windows" key on your keyboard. Next arrow down to "Accessories", arrow to the right one time, then arrow down to terminal and press the "enter" key. Once the terminal is up, type the following command to stop the Kiosk:

$ killall chromium-browsers

(This will stop the kiosk and allow you to run other scripts or use your pi how ever you desire.)

UNINSTALL

To uninstall the kiosk simply return to the terminal and run the following commands:

$ cd /home/pi/RpiKiosk_cli
$ chmod +x UndoPiKiosk.sh
$ ./UndoPiKiosk.sh

This will convert all config files back to original states and will enable the mouse if it has been disabled.

IN NO EVENT WILL WE BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, INCIDENTAL, SPECIAL OR EXEMPLARY DAMAGES FOR ANY USE OF THIS SITE, OR USE OF ANY OTHER LINKED SITE, OR SOFTWARE, EVEN IF WE ARE ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.