_____ _____ _____ _______ ____ ____ _ _____
| __ \ | __ \ |_ _| |__ __| / __ \ / __ \ | | / ____|
| |__) | | |__) | | | | | | | | | | | | | | | | (___
| _ / | ___/ | | | | | | | | | | | | | | \___ \
| | \ \ | | _| |_ | | | |__| | | |__| | | |____ ____) |
|_| \_\ |_| |_____| |_| \____/ \____/ |______| |_____/
- RPITOOLS is an installation and configuration (deployment) system for the raspberry pi family. It deploys the official raspbain lite operating system and many useful programs(1), and set the complete system to a tiny low cost perfectly configured server.
- Completly set for remote usage - ssh, sshfs, sftp, smb, vnc(optional), website(http), camera stream support (motion)
- Sets an optional GUI (PIXEL) for graphical usage
- Supports a UNIQUE extension shiled with many periphery (Oled, led, buttons, etc.).
- LIST OF MAIN FUNCTIONALITIES:
- torrent client - transmission (with http client, port: 9091)
- network drive - samba (smb), web UI (h5ai)
- OLED (128x64) display support on extension shield
- extarnal ip deepnet clinet access (dropbox - external ip sync)
- description for duckdns installation (get your free web domain)
- disks handling: autoformat, automount, with commandline interface
- user management (permissions, groups, seperated disk space, shared disk space) with commandline interface
- terminal/command line set for easy usage - aliases and so on ...
- vim, xdotool, scrot, python (with many modules), kodi etc.
- custom
rpitools/autodeployment/config/rpitools_config.cfguser configuration based onrpitools/autodeployment/config/rpitools_config_template.cfg - security: ufw, fail2ban
- backup handling - system, user - backup, restore
- autosync based on rsync: remote, local sync with modes: copy, move, mirror
- complete system monitoring solution - sysmonitor
- embedded multiprocess communication memdict with commandline interface
- easy update:
update_rpitools
(1) Installing many linux apps and serices, furthermore creates several custom services.
More detailed informations coming soon for every function
Deploy and setup raspbian image
-
macOS: open terminal
CMD+SPACEtypeTerminalpress enter -
Linux: open
terminalandsudo apt-get install git -
clone rpitools repository from github - to get the resources
git clone https://github.com/BxNxM/rpitools.git
- go to rpitools/
cd rpitools/
source setup.bash
#### SETUP EXECUTION ####
* Detect the device | linux | mac | raspbian
* [linux | mac] install requirements on deployment side
and set installation environment.
* [raspbain] manage depoyment depends on your custom config
#########################
Follow the instructions.
Note: First you need to set up your custom configuration with confeditor. It will use vim editor, commands cheetsheet for vim:
ESC MODE
:w - type & enter - save the actual file
:q! - type & enter - exit without save
:wq - type & enter - save and exit
jump end of the line: $
jump beginning of the line: 0
INSERT MODE
move the cursor with the arrows [up - down - right - left]
SHIT + v - type - select line
CTRL + v - type - select block
y - type - copy selected area
x - type - cut selected area
p - type - paste copied area
When your custom configuration (confeditor) is ready and validated, you can start to deploy your system.
- Execute deployment scripts:
./1_raspbian_imager.bash
###### DESCRIPTION ######
* It deploys (write) the factory raspbian_lite_latest image to the SD card.
(It serach your rapbian image from Downloads folder)
(If it not works copy your image under: rpitools/prepare/sd_card/raspbian_img)
#########################
./2_boot_config.bash
###### DESCRIPTION ######
* It makes an SD configuration, before the fisrt boot:
wifi, ssh, i2c, spi etc. based on previously set config file (rpitools_config.cfg)
#########################
- Unmount and disconnect the SD card from your computer. Take it to the pi, and power it up.
- Wait a little to boot up propely (max. 2-4 min.)
./3_remote_config_for_rpi_machine.bash
###### DESCRIPTION ######
* It copies all the rpitools repository to the raspberrypi
* Executes the rpitools/setup configuration sourcing
*** Based on your configuration (rpitools_config.cfg) it will prepare
your whole system.
* It takes 30-80 minutes (many installations and configurations with reboots)
#########################
./4_connect_and_enjoy.bash
###### DESCRIPTION ######
* FInally connect to your pi, and enjoy your NEW, PERSONAL environmat!
#########################
WIRING
OLED BOOTUP LAUNCH SETUP - CONFIGURE A SERVICE (optional) [1]
for more info:
oledinterface -h
- Use virtual buttons:
Oled dedicated buttons
oledinterface -b LEFT
oledinterface -b RIGHT
oledinterface -b OK
oledinterface -b standby
Oled page joystick buttons
oledinterface -j LEFT
oledinterface -j RIGHT
oledinterface -j CENTER
oledinterface -j UP
oledinterface -j DOWN
- create your own page under
/home/$USER/rpitools/gpio/oled_128x64/lib/pages/page_XY.py
Change XY to the next page number
Use the example page resources under page folder, and create your own custom pages. List existing pages with:
List folder content:
llt /home/$USER/rpitools/gpio/oled_128x64/lib/pages
or
ls -lath /home/$USER/rpitools/gpio/oled_128x64/lib/pages
- draw text
- draw shapes: ellipse, rectangle, line, poligon
- draw image
- automatic functions: header bar (optional), page bar (optional), button handling
- automatic button handling (physical and virtual over oledinterface)
- page control, load, run in loop, unload, next, previus etc...
RaspberryPi Zero W - get service CPU usage (average)
while true; do cpu=$(ps aux | grep -v grep | grep "oled_gui_core" | awk '{print $3}') && echo -ne "oledfw: $cpu %\r"; done
On MEDIUM performance set:
CPU LOAD: 25 % - 35 %
CPU if oled in STANDBY: 2.3 %
_ __ ____ _____ _____
| |/ / / __ \ | __ \ |_ _|
| ' / | | | | | | | | | |
| < | | | | | | | | | |
| . \ | |__| | | |__| | _| |_
|_|\_\ \____/ |_____/ |_____|
use hardware optimized media player for 720p and 180p videos
run in command line:
kodibg
It gives you a full media player with many options. The video output goes to the dedicated HDMI connector.
_ _ _ __
| | (_) | | / _|
_ __ __ _ | |__ _ _ __ | |_ ___ _ __ | |_ __ _ ___ ___
| '__| / _` | | '_ \ | | | '_ \ | __| / _ \ | '__| | _| / _` | / __| / _ \
| | | (_| | | |_) | | | | | | | | |_ | __/ | | | | | (_| | | (__ | __/
|_| \__, | |_.__/ |_| |_| |_| \__| \___| |_| |_| \__,_| \___| \___|
__/ |
|___/
To controll connected rgb leds.
- start rgb service - it controlls the leds - and process requests
rgbinterface -s ON
- turn on the leds
rgbinterface -l ON
- set colors
rgbinterface -r 0 -g 0 -b 0
rgbinterface -r 100 -g 100 -b 100
# color ranges: 0-100, min. step 1
- turn off the leds
rgbinterface -l OFF
- turn off the service
rgbinterface -s OFF
You don't have to turn off the service, it can runs in the background, so you can send data for it over rgbinterface and it makes the magic ;)
- show rgb leds service status
rgbinterface -sh
- interface help for informations
rgbinterface -h
_ _ _____ _______ _____ _____ ______ _ _ _____ _____ _ _ ______
| | | | /\ | __ \ |__ __| |_ _| / ____| | ____| | \ | | / ____| |_ _| | \ | | | ____|
| |__| | / \ | |__) | | | | | | | | |__ | \| | | | __ | | | \| | | |__
| __ | / /\ \ | ___/ | | | | | | | __| | . ` | | | |_ | | | | . ` | | __|
| | | | / ____ \ | | | | _| |_ | |____ | |____ | |\ | | |__| | _| |_ | |\ | | |____
|_| |_| /_/ \_\ |_| |_| |_____| \_____| |______| |_| \_| \_____| |_____| |_| \_| |______|
hapticengingeinterface -h
optional arguments:
-h, --help show this help message and exit
-u, --up HapticEngine UP signel
-d, --down HapticEngine DOWN signel
-s, --soft HapticEngine SOFT signel
-t, --tap HapticEngine TAP signel
-dt, --doubletap HapticEngine DoubleTAP signel
-sn, --snooze HapticEngine SNOOZE signel
usermanager --man
--man :: manual
--adduser :: Add new user with settings, <username> <userpasswd> 2 par
--removeuser :: Remove user, <username> 1 par
--changepasswd :: Change user password, <username> <userpasswd> 2 par
--userstat :: Show users list and used disk space 0 par
--logoff :: Log off user - select after execute 0 par
--fixusergroups :: Fix user groups for every user, except rpitools user 0 par
--addapacheuser :: Add user for apache - private cloud <username> <userpasswd> 2 par
backuphandler --man
========================== backup_handler ====================================
system backup - backup system [for migration]
with all user homes, user accounts and /var/www/html /var/lib/transmission-daemon/.config/transmission-daemon/torrents/ /var/spool/cron/ extra folders, optional parameter: --skiphomedirs
system restore - restore system [for migration]
with all user homes, user accounts and /var/www/html /var/lib/transmission-daemon/.config/transmission-daemon/torrents/ /var/spool/cron/ extra folders, optional parameter: --skiphomedirs
backup - backup home folders
restore - restores every users last backup in subfolder under its own home dir
restore <username> - restore a selected user last backup in subfolder under its own home dir
struct -show actual backup archive structure
sysmonitor -h
-h, --help show this help message and exit
-a, --all show all implemented informations
-t, --temp show cpu and gpu temerature
-c, --cpu show cpu usage
-d, --disk show disk usage
-m, --memory show memory usage
-l, --loggedin show logged in users
-g, --general show general informations
-o, --loop show informations in loop
-s, --services show rpitools services
-e, --export save measured health data to memdict
EXAMPLE: sysmonitor --services
_____ _____ _____ _ _
| __ \ | __ \ |_ _| | | | |
| |__) | | |__) | | | | |_ ___ ___ | | ___
| _ / | ___/ | | | __| / _ \ / _ \ | | / __|
| | \ \ | | _| |_ | |_ | (_) | | (_) | | | \__ \
|_| \_\ |_| |_____| \__| \___/ \___/ |_| |___/system monitor
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||| Sun May 5 09:55:22 BST 2019 |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||| RPItools monitor |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||| Hi, USER! Have a GOO:D time! ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||| SERVICES |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RPITOOLS SERVICES:
oled_gui_core active status: inactive
oled_gui_core enabled status: disabled
dropbox_halpage active status: active
dropbox_halpage enabled status: enabled
auto_restart_transmission active status: inactive
auto_restart_transmission enabled status: disabled
rpitools_logrotate active status: active
rpitools_logrotate enabled status: enabled
memDictCore active status: active
memDictCore enabled status: enabled
rgb_led_controller active status: inactive
rgb_led_controller enabled status: disabled
temp_controll_fan active status: inactive
temp_controll_fan enabled status: disabled
hAlarm active status: active
hAlarm enabled status: enabled
LINUX SERVICES:
apache2 active status: active
apache2 enabled status: enabled
transmission-daemon active status: active
transmission-daemon enabled status: enabled
motion active status:
motion enabled status:
smbd active status: active
smbd enabled status: enabled
minidlna active status: active
minidlna enabled status: enabled
ssh active status: active
ssh enabled status: enabled
nfs-kernel-server active status: active
nfs-kernel-server enabled status: enabled
glances active status: active
glances enabled status: enabled
cron active status: active
cron enabled status: enabled
networking active status: active
networking enabled status: enabled
MONITORED PROCESSES:
Xorg state: inactive
vncserver state: inactive
kodi state: inactive
autosync state: ok
backuphandler state: ok
OVERALL HEALTH [100.0%]:
:) 0...23 :( exit code: 0
confeditor -h
==== QUICK COMANDS ====
edit | e - edit configuration
diff | d - diff configuration with template config
save | s - save all rpitools system related configs to cache backup folder
restore | r - restore all rpitools system related configs from cache backup folder
import | i - [not on raspberry!] import existing configuration for deployment
OR RUN WITHOUT PARAMETERS, AND FOLLOW THE INSTRUCTIONS (RECOMMENDED)
You have a custom website, with protected files web folder - like custom dropbox (cloud) on a private drive at home. Get your internal or extarnal ip address and copy-paste it to your browser.
get your ip address on the pi:
sysmonitor -g
sudo bluetoothctl -a
[bluetooth]# power on
[bluetooth]# agent KeyboardOnly
[bluetooth]# pairable on
[bluetooth]# scan on
Last command will show all available (waiting for pairing) bluetooth keyboards like this.
Discovery started [CHG] Controller 06:05:04:03:02:01 Discovering: yes
[bluetooth]# pair 01:02:03:04:05:06
[bluetooth]# trust 01:02:03:04:05:06
[bluetooth]# connect 01:02:03:04:05:06
[bluetooth]# quit
Now put this simple script into /etc/init.d/keyboard
#! /bin/sh
sudo hcitool spinq
exit 0
Then execute these.
sudo chmod +x /etc/init.d/keyboard
sudo update-rc.d keyboard defaults
sudo service keyboard start
sudo service keyboard status
That's it. Now whenever you turn your Bluetooth keyboard on, it'll be connected to your Linux automatically.
- RaspberryPi GPIO usage:
https://sourceforge.net/p/raspberry-gpio-python/wiki/BasicUsage/
- GPIO pinout
https://pinout.xyz/pinout/pin1_3v3_power
- Download raspbian image (my project use the light version)
https://www.raspberrypi.org/downloads/raspbian/
- Raspbain image installation - manual - Windows / Mac / Linux
https://www.raspberrypi.org/documentation/installation/installing-images/
- My favourite raspberry pi order site (not sponsored - yet :P)
https://thepihut.com/products/raspberry-pi-zero-essential-kit
- Format disks
https://www.raspberrypi.org/forums/viewtopic.php?t=38429
- Useful - command line - commands collection
http://www.circuitbasics.com/useful-raspberry-pi-commands/
- Backup / Restore SDCard
https://thepihut.com/blogs/raspberry-pi-tutorials/17789160-backing-up-and-restoring-your-raspberry-pis-sd-card
http://bobbyromeo.com/technology/backup-clone-raspberry-pi-sd-card/
- Password protected apache folder setup
https://www.cyberciti.biz/faq/howto-setup-apache-password-protect-directory-with-htaccess-file/
- Other usefull commands in the system
Get Kernel modules load state (spi, i2c)
systemctl status systemd-modules-load.service
- Convert pdf to html
http://www.pdfonline.com/convert-pdf-to-html/
- Set crontab for programs time based execution
* * * * * command to be executed
- - - - -
| | | | |
| | | | ----- Day of week (0 - 7) (Sunday=0 or 7)
| | | ------- Month (1 - 12)
| | --------- Day of month (1 - 31)
| ----------- Hour (0 - 23)
------------- Minute (0 - 59)
string meaning
------ -------
@reboot Run once, at startup.
@yearly Run once a year, "0 0 1 1 *".
@annually (same as @yearly)
@monthly Run once a month, "0 0 1 * *".
@weekly Run once a week, "0 0 * * 0".
@daily Run once a day, "0 0 * * *".
@midnight (same as @daily)
@hourly Run once an hour, "0 * * * *".
crontab -e edit crontab
crontab -l list crontab settings
https://www.cyberciti.biz/faq/how-do-i-add-jobs-to-cron-under-linux-or-unix-oses/
- Image convert (convert howtogeek.png -quality 95 howtogeek.jpg)
https://www.howtogeek.com/109369/how-to-quickly-resize-convert-modify-images-from-the-linux-terminal/
- NFS howto
https://www.htpcguides.com/configure-nfs-server-and-nfs-client-raspberry-pi/
- Terminal colors
https://misc.flogisoft.com/bash/tip_colors_and_formatting
- ASCII ART
http://patorjk.com/software/taag/#p=display&h=0&f=Big&t=RPITOOLS%0A
- DynamicDNS - duck DNS
https://www.duckdns.org
- Elecrow HDMI 5" 800x480 TFT Display with XPT2046 Touch Controller
Sets everything:
driver: git clone https://github.com/Elecrow-keen/Elecrow-LCD5.git
# Manual setup:
https://www.jeffgeerling.com/blog/2016/review-elecrow-hdmi-5-800x480-tft-display-xpt2046-touch-controller
- retropie - the best gaming platform
https://retropie.org.uk/docs/Manual-Installation/
- acct (Process accounting) - user monitor
https://www.ostechnix.com/monitor-user-activity-linux/
- SSHFS on windows
https://github.com/feo-cz/win-sshfs/releases
- Learn git usage interactively
https://learngitbranching.js.org
push master repo: git push -u origin master
push develop repo: git push -u origin develop