Regbot GUI: Difference between revisions

From Rsewiki
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
Back to [[Regbot]]
Back to [[Regbot]]
Back to [[Robobot]]


== Install Python ==
== Install Python ==


On a windows computer:
Install python and the python install program pip.


Start the command window by searching for 'cmd' after pressing the windows button.
=== Windows ===


On a Linux computer, install pip (Python install program)
Install Python from Microsoft store (Includes pip).
(Should be python version 3.x)


sudo apt install pip
=== Mac ===


Check the version of Python. In the command window, start python
Install Python (version 3.x)
python
Maybe it is installed by default
Python 3.6.9 (default, Oct  8 2020, 12:12:24)  
(I have no MAC)
on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> quit()


This should start python and write the version number. Version must be 3.X.X.
=== Linux ===


If not installed, then install from Microsoft store, you will probably be directed directly, if not installed.
install pip (Python Install Program)


=== Install packages ===
sudo apt install python3
sudo apt install pip


At the CMD prompt, install:
To be consistent, either use a virtual environment and install with pip, or
install packages with apt:


  > sudo pip install pyqt5
  sudo apt install python3-pyqt5
  > sudo pip install pyqtgraph
  sudo apt install python3-serial
  > sudo pip install pyserial
  sudo apt install python3-pyqtgraph


If everything goes well, then you are ready to run the GUI from the Python script.
== Install Python packages ==


=== Linux (or Apple)===
=== Windows ===


If you run Linux, the above are the packages you need here too.
Open a terminal window (search for 'cmd' app)


I haven't tested on Apple, but maybe.
At the command prompt install these packages:


== Get REGBOT GUI ==
> pip install pyqt5
> pip install pyserial
> pip install pyqtgraph
> pip install numpy


===Install SVN===
=== MAC ===


The source is on a SVN repository, if not available, then install:
The same packages are needed.


Install TortoiseSVN from https://subversion.apache.org
=== Linux ===
On left menu find "Binary packages" and from here the 'Windows' section


* Download TortoiseSVN
> pip install pyqt5
* Install, and remember to add 'command line' support.
> pip install pyqtgraph
* restart a 'cmd' terminal after installation
> pip install pyserial
> pip install numpy


=== Get the GUI (SVN repository) ===
== Get REGBOT GUI ==


The file-browser may have support for SVN (or it can be added), in this case 'checkout' the regbot_gui on this address
The REGBOT GUI is just a set of python files


svn://repos.gbar.dtu.dk/jcan/regbot/regbot_gui
There are two options
* Get the python files from a zip-file (available in Learn)
* Get the newest version from repository (SVN)


On Linux (and maybe Apple) install subversion (Linux: sudo apt install subversion)
=== From zip file ===


The checkout with the command
Unzip the Python files (many files (23), so keep them in a clean directory).


svn checkout svn://repos.gbar.dtu.dk/jcan/regbot/regbot_gui
=== From SVN repository ===


=== Get the GUI (GIT repository) ===
Make sure your PC has SVN (Apache subversion) support.


A snapshot of the GUI is provided for Teensy version 1535 (14 February 2023) in a git repository
===== Windows =====


Find the repository and the python files here
Install e.g. SilkSVN (https://sliksvn.com/download/), this is a command-line interface, but there are other packages too.


https://repos.gbar.dtu.dk/git/jcan/regbot_gui.git
Start a 'cmd' terminal after installation.


Copy files or clone to your disk
===== Linux (and MAC) =====


git clone https://repos.gbar.dtu.dk/git/jcan/regbot_gui.git
sudo apt install subversion


NB! The SVN repository is regularly updated and this GIT version may be outdated.
==== Get the GUI Python files ====


== Run the GUI ==
Open a terminal window, change the directory, to where you want to install, e.g. called 'svn'
 
=== The python version ===
 
In the regbot_gui directory, run the regbot.py script.
 
* On Linux, this command line should work:


mkdir svn
cd svn
svn checkout svn://repos.gbar.dtu.dk/jcan/regbot/regbot_gui
  cd regbot_gui
  cd regbot_gui
python3 regbot.py


* On Windows
There should be several Python files, including 'regbot.py'.


Find the directory in your file browser (Stifinder)
== Start the Regbot GUI ==


Start the file 'regbot.py' - maybe create a shortcut on the desktop.
Go to the directory, where the Python files are placed.


If there are errors about libraries, then check if they are installed (from the list above).
* Execute the 'regbot.py' file.


=== Regbot.exe for Windows ===
From a terminal


A windows executable is generated (using the instructions below); this is found in a subdirectory called "dist".
  cd regbot_gui
 
  python3 regbot.py
> cd Downloads
> cd regbot
  > cd regbot_gui
  > cd dist
> regbot
 
Use the browser to locate the file and execute it.
It also holds all the needed python-libraries, so it takes a long time to start.
 
The regbot.exe file is made on a Windows 10 (I don't have anything newer if there are problems; revert to the Python version)
 
NB! the version from 2022 does not work anymore; it has to have a date from 2023.
 
=== Regbot GUI use===
 
See the [[User interface]]
 
== Make a windows EXE file ==
 
If you installed all the python stuff, you don't need the exe file.
 
To make a single exe-file without the need to install anything, then it is a bit more complicated (for me at least)
 
===Install python===
 
* Install python (tested with version 3.8) from https://www.python.org/downloads/ - select 'all users' in install options and also select 'add to path'.
 
After installation, start 'cmd' terminal windows as administrator (right-click on 'cmd' and select 'as administrator') to install additional packages using 'pip'.
 
> pip install pyqt5
> pip install pyqtgraph
> pip install pyserial
> pip install pyinstaller
> exit
 
===Generate EXE file ===
 
Open a 'cmd' terminal window as a normal user
 
Then make the EXE-file from the directory with the REGBOT GUI
 
> cd Downloads\regbot_gui
> pyinstaller --onefile regbot.py
 
This takes some time, and the regbot.exe should be found in a 'dist' subdirectory.
 
Try:
> cd dist
> regbot.exe
 
PS! tried also with Python 3.9, but regbot.exe failed with the error: "PyQt5.sip not found".

Latest revision as of 11:24, 29 October 2025

Back to Regbot

Install Python

Install python and the python install program pip.

Windows

Install Python from Microsoft store (Includes pip). (Should be python version 3.x)

Mac

Install Python (version 3.x) Maybe it is installed by default (I have no MAC)

Linux

install pip (Python Install Program) 

sudo apt install python3
sudo apt install pip

To be consistent, either use a virtual environment and install with pip, or install packages with apt: 

sudo apt install python3-pyqt5
sudo apt install python3-serial
sudo apt install python3-pyqtgraph

Install Python packages

Windows

Open a terminal window (search for 'cmd' app)

At the command prompt install these packages: 

> pip install pyqt5
> pip install pyserial
> pip install pyqtgraph
> pip install numpy

MAC

The same packages are needed.

Linux

> pip install pyqt5
> pip install pyqtgraph
> pip install pyserial
> pip install numpy

Get REGBOT GUI

The REGBOT GUI is just a set of python files

There are two options

  • Get the python files from a zip-file (available in Learn)
  • Get the newest version from repository (SVN)

From zip file

Unzip the Python files (many files (23), so keep them in a clean directory).

From SVN repository

Make sure your PC has SVN (Apache subversion) support.

Windows

Install e.g. SilkSVN (https://sliksvn.com/download/), this is a command-line interface, but there are other packages too.

Start a 'cmd' terminal after installation.

Linux (and MAC)

sudo apt install subversion

Get the GUI Python files

Open a terminal window, change the directory, to where you want to install, e.g. called 'svn' 

mkdir svn
cd svn
svn checkout svn://repos.gbar.dtu.dk/jcan/regbot/regbot_gui
cd regbot_gui

There should be several Python files, including 'regbot.py'.

Start the Regbot GUI

Go to the directory, where the Python files are placed.

  • Execute the 'regbot.py' file.

From a terminal 

cd regbot_gui
python3 regbot.py
Retrieved from "https://rsewiki.electro.dtu.dk/index.php?title=Regbot_GUI&oldid=8336"