abilium-gmbh / low-power-rfid-attendance-recorder-for-odoo

Low-Power-RFID-Attendance-Recorder-for-Odoo

Setup Raspberry PI

1. Format your sd card. (FAT32)

2. Flash raspberry OS to microSD card using https://www.raspberrypi.com/software/

3. Go on Advanced Settings and activate ssh

4. Also choose a username and a password

5. Tick the box for setting up the WiFi and configure your WiFi settings

6. Configure your Timezone

7. Insert microSD card into the raspberri PI and power it up using USB-C cable

8. Scan the IPs in your network for the raspberri PI

9. Connect to the raspberry using ssh pi@IP-ADDRESS and your password

10. Run sudo raspi-config and enable interface SPI

Setup display and RFID

1. Run the following commands

sudo apt-get update
sudo apt-get install python3-pip
sudo apt-get install python3-pil
sudo apt-get install python3-numpy
sudo apt-get install python3-venv
sudo apt-get install python3-rpi.gpio python-pil python-smbus python-dev libopenjp2-7
sudo pip3 install RPi.GPIO
sudo pip3 install gpiozero netifaces spidev rpi.gpio pillow
sudo pip3 install mfrc522
pip install -U numpy
pip3 install opencv-python 
sudo apt-get install libcblas-dev
sudo apt-get install libhdf5-dev
sudo apt-get install libhdf5-serial-dev
sudo apt-get install libatlas-base-dev
sudo apt-get install libjasper-dev 
sudo apt-get install libqtgui4 
sudo apt-get install libqt4-test

2. Clone our project

git clone https://github.com/Abilium-GmbH/Low-Power-RFID-Attendance-Recorder-for-Odoo.git

Connect with Odoo

There are two ways to connect the project with the odoo server:

1. Enter the directory for enviroment variables

sudo nano etc/environment

2. Add the following lines with the information of the relevant odoo server. This is possible with API keys or hardcoded letters

ODOO_URL="YOUR-URL"
ODOO_USERNAME="YOUR-USERNAME"
ODOO_DB="DATABASE_NAME"
ODOO_PASSWORD="YOUR_PASSWORD"

3. Save the file and test with the commands below

echo $ODOO_URL
echo $ODOO_USERNAME
echo $ODOO_DB
echo $ODOO_PASSWORD

The second variant works by hardcoding the information into the responsible file

1. Run the following commands

cd Low-Power-RFID-Attendance-Recorder-for-Odoo/src/odoo
sudo nano interpreter.py

2. Write the information from the server into the init method instead of the enviroment variables. They are marked with the comments.

    def __init__(self) -> None:
        url = environ['ODOO_URL'] #"YOUR-URL"
        user = environ['ODOO_USERNAME'] #"YOUR-USERNAME"
        self.db = environ['ODOO_DB'] #"DATABASE_NAME"
        self.password = environ['ODOO_PASSWORD'] #"YOUR_PASSWORD"
        self.common = xmlrpc.client.ServerProxy(
            '{}/xmlrpc/2/common'.format(url), allow_none=True)
        self.uid = self.common.authenticate(self.db, user, self.password, {})
        self.models = xmlrpc.client.ServerProxy('{}/xmlrpc/2/object'.format(url),
                                                allow_none=True) 

3. Save the file and quit it

FOR BOTH VARIANTS IMPORTANT!

Save the number of the card of an employee into odoo as the Badge ID

Test Hardware

1. Run commands

cd Low-Power-RFID-Attendance-Recorder-for-Odoo/src
python integration_test.py

2. Follow the instructions written on the display to see if the hardware works

How to use the attendance recorder

1. Hold the Badge or Token near to the scanner to Check-In or to Check-Out. Just to state the obvious: If an employee is Checked-Out this will Check-In the employee and vice versa. It is still possible to manually Check-In or Out by connecting to odoo.

2. Holding a Badge or Token near the RFID-Reader, after you pressed one of the four buttons left to the display, will lead to the following results: (They are labeled from top to bottom.)

   1\. By pressing the first button one can see whether the employee is currently Checked-In or Out.
   
   2\. By pressing the second button one can see the IP-Address of the device.
   

References

• WaveShare 2.7Inch e-Paper Display Wiki https://www.waveshare.com/wiki/2.7inch_e-Paper_HAT_(B)
• MFRC522 library https://github.com/pimylifeup/MFRC522-python
• MFRC522 datasheet https://www.nxp.com/docs/en/data-sheet/MFRC522.pdf
• Raspberry PI 4 Pinout https://maker.pro/storage/g9KLAxU/g9KLAxUiJb9e4Zp1xcxrMhbCDyc3QWPdSunYAoew.png
• RFC522 Board Tutorial https://pimylifeup.com/raspberry-pi-rfid-rc522/

low-power-rfid-attendance-recorder-for-odoo's Issues

Refactoring for testing

• Moving big codeblocks in seperate classes e.g. drawings on the e-paper

Display the monthly working time(13h)

• Get attendance logs from the employee of this month.
• Add them together and display the result on the e-paper.

Display time(5h)

• Update the e-paper every minute to get the new time.

Initialscreen time is not refreshed

Fix bug, so the time display is refreshed before a new time is displayed

Load logs from server (10h)

Display IP adress with button(8h)

• Easy way (slow):
  Display the IP by pressing a button after someone checked in or out. For security this might be better.

• Hard way (faster?)
  Add a new button with gpio. Make expectation handler for this all the time.

GUI update

• make sure long names are displayed correctly
• have a coherent design

Bugs debugen, for loop, nicht eingetragene IDs (10h)

Do Usability-Tests

Let not involved people try out the product.
Maybe we find issues.
Also try to give them the user manual and see how they do.

Plugin für Server mit IST/SOLL Vergleich Arbeitsstunden (?h)

Send ID to server (Check-in and Check-out) (13h)

Time Update (3h)

The time displayed on the standby screen is not updated automatically. The display would need to refresh every second to update the minute counter of the time on the display when no check in check out action is performed.

Write Documentation/User manual

To make sure the usermanual/documentation is complete: Reset Raspberry Pi and try the manual.
If there are libraries missing => update it

Duty Cycling RFID (2h)

The RFID reader creates lots of EMF-Noise and should thus not run continuously. A duty cycle of 0.5 was requested by the customer.

Testing nach Zühlke (?h nach absprache mit Zühlke)

SPI Probleme (8h)

Low-Power Versuch mittels Lichtschranken (no longer wanted by customer)

Absprache mit Abilium bzgl. Low-Power (5h)

Done, because Abilium wants to skip the LOW-Power attempt.

Download the logo from odoo and display it (13h)

• Find out how to get the logo from Odoo
• Get the bytestring to image_512 from odoo
• Convert it with base64 and save it as png
• resisze it
• convert to bmp
• display it

Refactoring the main file(3h)

-Find code blocks in the main file that need documentation.
-Put them into a self explanatory method in another class.

Integration Test (Hardware)

Planning the Testing after the Zühlke-Meeting(2h)

Improve performance (1h)

• remove color

Create unit tests(4h)

-Tests for the refactored classes and methods

Familiarizing (15h)

-This is always done a little

Find out if employee is checked in by pressing a button (5h)

• Use gpio pins to make a button to press and afterwards wait for a card id, to find out wheter this person is checked in.

Empty Attendances (4h)

Crash when employee without attendances are fetched.

Code refactoring (8h)

done:

• odoo part

Still to do:

• refactor RPi part