User Tools

Site Tools


4.0.0:index

Version 4.0.0

Installation

There are two ways you can install AdoPiSoft System into your machine:

1. Image Flashing

Image flashing is the easiest way to install the system into your machine (if an image is available for your board/machine).

Softwares to Download:

  1. Download Etcher
  2. Download the Software Image appropriate for your board/machine.

After downloading the needed softwares, we need to flash the image into the midro SD card using Etcher. To do so, unzip the contents of the zip file (adopisoft-xxxxx.zip).

Insert the micro SD card into the your computer using a card reader.

Open Etcher and click Select Image.

Then select adopisoft-(version).img from the zip file.

Make sure to select your micro SD card

Click the Flash button and wait for the process to finish.

NOTE: If you encounter prompts about formatting your sd card, just click Cancel.

Now, you are ready to configure the machine. Eject the SD card and Proceed to Initial Setup section.

2. Command-Line

Important: Before proceeding with command-line installation, it is assumed that you are already familiar on how to install a debian-based operating system into your board/machine.

Command line installation is used when software image is not available for your board/machine. First, you need to have access to the command line of your board/machine. In this guide, we will use Raspbian as an example. But this guide is also applicable to any debian-based OS like Armbian and Ubuntu Server 16.04/18.04 (for virtual machines). For Orange PI boards, you can download the OPI image here. Just follow the corresponding board type and their supported OS.

NOTE: Make sure to install a command-line OS only. OS's with desktop environment is not supported. For Raspberry Pi, this means the Raspbian Lite image. For Ubuntu, choose the Ubuntu Server ISO. Armbian is almost always command-line only.

Connect your LAN cable, keyboard, monitor and USB to LAN adapter(optional) to your board. Then power on your board and wait for the login screen to appear. The default user for Raspbian is pi with password raspberry.

For armbian: After logging in, you will then be asked to create a new user. Just follow the instructions on your device's screen. After creating a new user, you are now ready to install the system into your board/machine.

Just copy-paste the commands below line by line:

sudo apt-get update && sudo apt-get upgrade -y
sudo apt-get install curl -y
curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
sudo apt-get install -y nodejs python nginx bind9 isc-dhcp-server
sudo apt-get install -y hostapd dmidecode build-essential openssh-server python-pip unzip bridge-utils

This is for Orange Pi only:

sudo pip install --upgrade OPi.GPIO

Note: You can find your board's architecture using:

dpkg --print-architecture

For Raspberry Pi 3 & 4, OrangePi Zero/One/PC (armhf architecture):

wget https://github.com/AdoPiSoft/Releases/releases/download/4.0.3/adopisoft-4.0.3-armhf-node-v12.16.1.deb
sudo apt-get install ./adopisoft-4.0.3-armhf-node-v12.16.1.deb

For x64 machines - VM's/Server (amd64 architecture):

wget https://github.com/AdoPiSoft/Releases/releases/download/4.0.3/adopisoft-4.0.3-amd64-node-v12.16.1.deb
sudo apt-get install ./adopisoft-4.0.3-amd64-node-v12.16.1.deb

For RaspberryPi, you have to unblock wifi:

sudo rfkill unblock 0

Make sure to disable SSH service after a successful installation. Warning: You will not be able to access your board/machine command-line remotely after this.

sudo systemctl disable ssh

Now, reboot your board/machine and proceed to Initial Setup section.

sudo reboot

Note: The default database used is sqlite because it's the only database that can be package into the debian file. But we highly advice to change the database to postgresql after you have successfully setup the admin.

Run the command below line by line to create postgresql account:

(if the script will not work you can follow the step by step guide here)

wget https://gist.githubusercontent.com/alenteria/791dbe32175a01d1f1b602b25489ad22/raw/9a5aa879ac70d24bd9a7dd7f8ed97d7fe2c2f597/ado-psql-script.sh 

sudo chmod a+x ./ado-psql-script.sh
sudo ./ado-psql-script.sh

Then in the admin “Security → Data Connection” settings, change the config to:

Database Type: postgres
Host/IP: localhost
Port Number:
Database Name: adopisoft
Username: adopisoft
Password: adopisoft

Restart machine and go back to “Security → Data Connection” after boot and click “Run migrations”.

Initial Setup

IMPORTANT: Make sure you do the following before turning on your board/machine:

  • Insert the SD card into the board's SD card slot.
  • Insert the LAN cable into the ethernet port of board/machine and make sure it is connected to internet
  • Insert USB to LAN adapter (if your board doesn't have wifi interface).

Find your board/machine's IP address. In your board/machine's screen, just type:

ip addr

On windows, you can install network scanner on your PC to scan for your board/machine's IP.

Once you have identified your board/machine's IP address, open your browser on your PC and type the url to your board/machine's IP address.

Example:

http://192.168.1.123

Installation Wizard

Setup Account

  1. Type your password
  2. Confirm your password
  3. Click Save Changes button

Select Board

  1. Choose your board/machine type
  2. Click Save Changes

Setup WAN

  1. Select your WAN network interface. The system will automatically recommend the interface connected to your network.
  2. Click Set as WAN Interface button
  3. Configure your WAN interface (Dynamic IP or Static IP). If not sure, check Obtain IP from DHCP server.
  4. Click Save Changes button

Setup LAN

Important: Make sure your board/machine has two network interface. For boards without wifi interface, you have to insert the USB to LAN adapter first.

  1. Choose the network interface for your LAN. It can be the wifi interface (wlan0 or wlpsxxx) or any ethernet interface.
  2. Check Enable Captive Portal
  3. Set alias to LAN Interface or Built-in WiFi (or anything you like)
  4. Uncheck Obtain IP from DCHP server
  5. Set Statc IP Address to 10.0.0.1
  6. Set Network Prefix to 20
  7. Check Use System DNS Server
  8. Check Enable DHCP Server on this interface
  9. Set DHCP Pool Start to 10.0.0.10
  10. Set DHCP Pool End to 10.0.15.254
  11. Click Save Changes button
  12. Click Done or Finish button.

Setup WiFi

NOTE: This is only applicable for boards/machine with built-in wifi interface like Raspberry Pi.

  1. Check Enable Built-in WiFi
  2. Set WiFi Name to your preference
  3. Check Open WiFi
  4. Check Don't limit the number of users
  5. Set LAN Interface to wlan0 (or whatever the name of your wifi interface)
  6. Select channel to your preferrence (default 1)
  7. Click Save Changes button

Reboot

Reboot your machine. Then proceed to Wired Coinslot Configuration section.

Dashboard

System Status

Contains details about CPU, RAM, storage, network interfaces and network traffic.


Announcements

Contains announcements fetched from our server. Contents of this page can also be viewed at website home page.


WiFi Users

WiFi Users List

In wifi users list, you can view the devices connected to wifi which includes the hostname, mac address, ip address and status of individual device.

For each device, you have the options to view sessions, edit and block or unblock the device.

WiFi User Sessions

You can view the sessions for each individual device.

You can add/edit/remove individual sessions. Please see Session Types for more information about session types.

Edit Device

Edit device details like hostname, mac address and ip address.

Payment Portals

Built-In / Wired

Built-in coinslot uses on-board GPIO pins as sensor for coin acceptors.

Configuration

  1. Click Add Wired Coinslot button
  2. Select GPIO coinslot type
  3. Set alias (ex. Frontyard Coin Slot)
  4. Set GPIO Pin for Coin Acceptor to 3 (or any GPIO pin you prefer)
  5. Set GPIO Pin for Bill Acceptor (if you have bill acceptor)
  6. Set the relay settings if you have a relay setup for inhibit pin (opotional). Please refer to relay_setup for more information.

Wiring Diagram (RPI)

Click on the image below to view full size.

Wiring Diagram (OPi One & PC)

GPIO Numbering

Please refer to gpio_numbering page.

Serial Coinslot

Serial coinslot uses Arduino to handle credit pulses, lcd display, and keypad E-loading. The data is transmitted via USB serial.

Flash Arduino

Configuration

  1. Click + Add Wired Coinslot button
  2. Select Serial coinslot type
  3. Set alias (ex. Frontyard Coin Slot)
  4. Set Serial Device port (usually /dev/ttyUSB0)
  5. Set Serial Baud Rate to 9600
  6. If your setup has lcd module, click Show LCD Display Settings and tick the menu you want to appear in the LCD.
  7. If you tick the Enable Hotspot menu, WiFi SSID field will show. This will reflect in the LCD display that will serve as an instruction to customers on which SSID they should connect.
  8. Connect your Arduino to the machine via USB and restart to apply changes.

Wiring Diagram

Materials Needed:

  1. Arduino Uno or any arduino with equal or higher memory capacity than uno
  2. Universal Coin Acceptor
  3. 4×3 Membrane Keypad Module (Optional, only if E-loading is enabled)
  4. ST7920 128×64 LCD Display Module (Optional)
  5. Bill Acceptor (Optional)

Download Diagram

Wireless Coinslot

Wireless coinslot uses ESP8266 board as coinslot sensor. You can also connect LCD and keypad to the ESP8266 board for E-loading setup. The ESP8266 will automatically connect to the machine given that it has the correct ssid config and has matching token or encryption key. Connected ESP8266 devices will show in the CONNECTED WIRELESS COINSLOTS table. Click on the edit or pencil icon on the device to show the LCD menu settings.

Configuration

  1. Set SECURITY TOKEN (This should match with the ESP8266's token)
  2. Flash your ESP8266 board. Please refer to ESP8266 Flashing guide for more information.
  3. Configure your ESP8266. Please refer to esp8266_configuration_guide for more information.

Basic Diagram

Materials needed:

  1. NodeMCU or WEMOS
  2. Universal Coin Acceptor

Download Diagram

Wiring Diagram With Keypad E-loading

Materials needed:

  1. NodeMCU or WEMOS
  2. Universal Coin Acceptor
  3. Arduino Uno or Nano
  4. 4×3 Membrane Keypad Module
  5. ST7920 128×64 LCD Display Module
  6. Bill Acceptor

Download Diagram

Important Note: All the modules should be in common grounds, or use common power adapter. For bill acceptor, don't directly connect the inhibit wire into the ESP8266 as it can damage your board. Use a relay to ON and Off the ground connection to the inhibit.

If you want to add Buzzer Sound module, please refer to Buzzer module for more information.


Terminologies

Session Types

There are 3 main types of sessions in our system available in captive portal:

1. Time Session

This is the traditional session with remaining time in seconds. But unlike before, each transaction has separate time. They are not combined to previous session. The session becomes invalid once the user has consumed the allocated time.

2. Data Session

This session is based on data consumption of the user. The session becomes invalid once the user consumed the allocated data in megabytes (MB).

3. Time or Data Session

Whichever is consumed first, time or data. The session will become invalid once either of time or data is consumed by the user.

The user can have multiple sessions, including the subscription session. Once the previous session is consumed, it will automatically activate the next available session. If the user has no more sessions available, the user is automatically disconnected from the internet.

Subscription Session

The other type of session is Subscription. Subscription session does not have allocated time or data. Instead, it will only track the data consumption of the device and how long the session has been running. Subscription session can only be generated manually in the dashboard for the intended device or through voucher. It can be used to allow only specific hosts to connect outside the network - e.g. smart TV’s, CCTV/IP Cameras, etc. aside from walled-garden based on TCP/IP port numbers. It can also be used to accommodate a whole household using a voucher with subscription type session.

Each session is editable and has the following options:

  • Download/Upload Bandwidth Limit
  • Allow/Disable Pause
  • Expiration Date/Time
  • Change Session Type (options: time, data, time or data, subscription)
  • Add/Subtract remaining time or data
  • Delete session

The default bandwidth of a session is taken from captive portal bandwidth settings. The default session expiration is taken from session settings in the admin dashboard. The expiration date/time can be disabled.

4.0.0/index.txt · Last modified: 2020/06/30 05:26 by admin