Το συγκεκριμένο project υλοποιεί μία μέθοδο επικοινωνίας publish/subscribe χρησιμοποιώντας τον [**RabbitMQ Broker**](https://www.rabbitmq.com/).
This project implement a communication method publish/subscribe using [**RabbitMQ Broker**](https://www.rabbitmq.com/).
Η υλοποίηση αυτή μεταξύ άλλων προσθέτει λειτουργίες όπως, η εγγραφή των ληφθέντων τιμών σε μια βάση με σκοπό την απεικόνισή τους και την αποστολή των ίδιων τιμών σε έναν απομακρυσμένο server για την περαιτέρω επεξεργασία τους.
This implement adds functions as, write of the values receipt to a database in order to represent and to send these same values to a remote server for further procedure.
## Αρχιτεκτονική
## Architecture
Η αρχιτεκτονική χωρίζεται σε 5 μεγάλα κομμάτια :
This architecture is divided into 5 big parts :
1) Τον producer όπου παράγει και στέλνει τις τιμές του αισθητήρα.
1) The producer who produce and send the values to the broker.
2) Τον [**RabbitMQ broker**](https://www.rabbitmq.com/) όπου αποθηκεύει προσωρινά τις τιμές που στέλνει ο producer.
2) The [**RabbitMQ broker**](https://www.rabbitmq.com/) which stores temporarily the values sent by the producer.
3) Τον consumer που καταναλώνει τις αποθηκευμένες απο τον broker τιμές.
3) The consumer which consumes the stored values from the broker.
4) Την βάση και το monitoring tool , όπου αποθηκεύονται και προβάλλονται οι τιμές.
4) The database and the monitoring tool, into which the values stored and projected.
5) Τον απομακρυσμένο server όπου αποστέλλονται οι τιμές για περαιτέρω επεξεργασία.
5) The remote server where the values sent for further procedure.
- Κατεβάζουμε το repo απο το site του swarmlab [link](https://git.swarmlab.io:3000/PurpleRose/RabbitMQ_IoT_Project). Έχουμε στα χέρια μας 5 φακέλους, έναν για κάθε κομμάτι που θα πρέπει να στήσουμε.
- Download the repository from the website of swarmlab [link](https://git.swarmlab.io:3000/PurpleRose/RabbitMQ_IoT_Project). Thus, we have handy 5 folders, one per piece we have to setup.
## Αrduino
## Αrduino
Ξεκινώντας με το Arduino, θα πρέπει να το συνδέσουμε με τον υπολογιστή μας και μέσο της πλατφόρμας Arduino IDE(αν δεν υπάρχει την κατεβάζουμε και την εγκαθιστούμε [link](https://www.arduino.cc/en/software)) να περάσουμε τον κώδικα που βρίσκεται στο αρχείο **readTempValuesFromArduino.ino** στο Arduino.
Beginning with Arduino, we have to connect it with our computer and the connecting platform Arduino IDE (if not present download and install it) [link](https://www.arduino.cc/en/software)) in order to insatll the code in the file **readTempValuesFromArduino.ino** of Arduino.
Πιθανό πρόβλημα κατά τη μεταφορά του κώδικα στο Arduino:
Possible issue in the code transfer to Arduino:
[can't open device "/dev/ttyUSB0": Perm. denied (Linux permissions)]
[can't open device "/dev/ttyUSB0": Perm. denied (Linux permissions)]
Λύση:
Solution:
Ανοίγουμε το τερματικό του συστήματός μας και πληκτρολογούμε:
Open the terminal of the system and type:
sudo chmod ugo+w /dev/ttyUSB0
sudo chmod ugo+w /dev/ttyUSB0
> Την ίδια εντολή πρέπει να τρέξουμε και στο raspberry όταν θα το
> The same command must be run to the raspberry upon we
> συνδέσουμε με το Αrduino.
> connect to Αrduino.
#### Σύνδεση του αισθητήρα με το Arduino
#### Sensor's Connection to Arduino
Όπως φαίνεται και πιο πάνω στην εικόνα της αρχιτεκτονικής, ο αισθητήρας έχει τρία πόδια **(Vcc, Gnd , values).**
As shown in the architecture's picture above, the sensor includes three (3) connections **(Vcc, Gnd, Values).**
Συνδέουμε λοιπόν το μεσαίο πόδι του αισθητήρα με την αναλογική υποδοχή **Α0 (όπως φαίνεται και στον κώδικα)**
We connect the middle connector to the sensor with the analog input **Α0 (as shown in the code)**
για να μπορούμε να παίρνουμε τις τιμές του, το αριστερό του πόδι στη **τάση (Vcc)** και το δεξί του πόδι στη **γείωση (Gnd)**.
for receiving its values, the left connector to the **Current (Vcc)** and the right connector to the **Ground (Gnd)**.
**(1)** Με βάση τον κώδικα για το Arduino μπορούμε να αλλάξουμε το **pin** για τις τιμές του αισθητήρα απο **Α0** σε όποια αναλογική επαφή θέλουμε και αντίστοιχα αλλάζουμε και το **pin** στο κώδικα.
**(1)** Based on the code of Arduino we are able to use the **pin** for the sensor's values from **Α0** in any analog connection and we change the **pin** in the code also.
**(2)** Αντίστοιχα μπορούμε να αλλάξουμε τη τιμή στη συνάρτηση **delay** με σκοπό την πιο συχνή ή την πιο αραιή δειγματοληψία.
**(2)** Also, we are able to change the value to the function **delay** in order of the quicker or slower sample receipt.
**(3)** Πατάμε το κουμπί για **compile** και αν δεν υπάρχουν λάθοι στο κώδικα...
**(3)** Click the button for **compile**. In the case which no errors occured...
**(4)** Πατάμε το κουμπί για **upload** στο Arduino.
**(4)** Click the button for **upload** to Arduino.
## Raspberry
## Raspberry
### Producer
### Producer
Υλοποιούμε τα βήματα σχετικά με το Raspberry που βρίσκονται [εδώ](http://docs.swarmlab.io/SwarmLab-HowTos/labs/IoT/SensorNode2Server.adoc.html) προκειμένου να έχουμε πρόσβαση στη συσκευή.
Follow the steps concerning Raspberry here [here](http://docs.swarmlab.io/SwarmLab-HowTos/labs/IoT/SensorNode2Server.adoc.html) in order to gain access.
Εφόσον είμαστε μέσα στη συσκευή μεταφέρουμε τα αρχεία που κατεβάσαμε απο το **repo** και βρίσκονται μέσα στο φάκελο**MyProducer** (producer.js, package.json).
Upon we are in the system we transfer the downloaded files from the **repository** in the folder**MyProducer** (producer.js, package.json).
Στη συνέχεια τρέχουμε την εντολή:
Then, run the command:
npm install
npm install
Για να μας κατεβάσει στη συσκευή όλα τα dependencies που χρειάζεται το script producer.js για να τρέξει σωστά.
To download all the dependencies needed to the script producer.js to run normally.
Και τέλος τρέχουμε την εντολή:
Finally, run the command:
sudo chmod ugo+w /dev/ttyUSB0
sudo chmod ugo+w /dev/ttyUSB0
Για να μπορεί να στείλει το Arduino δεδομένα μέσο της σειριακής επαφής.
In order Arduino to send the data through the serial connection.
Αν δεν υπάρχει η **ttyUSB0** επαφή για επικοινωνία στο Raspberry τότε τρέχουμε:
If not present the **ttyUSB0** connection then run:
ls /dev/tty*
ls /dev/tty*
Για να δούμε όλες τις επαφές του Raspberry και σε ποιά είναι συνδεδεμένο το Arduino.
To detect all Raspberry connections and into which Arduino is connected.
Επαναλαμβάνουμε την εντολη αλλαγής δικαιωμάτων με τη κατάλληλη επαφή.
Repeat the change mode command (chmod) with the appropriate connection.
## Docker
## Docker
Για να μπορέσουν οι υπόλοιπες υπηρεσίες να τρέχουν θα χρειαστεί να εγκαταστήσουμε το **Docker** και το **Docker Compose** στον τοπικό μας υπολογιστή [link](https://www.docker.com/).
For working the rest of the services need to install **Docker** and the **Docker Compose** to the local computer. [link](https://www.docker.com/).
### Consumer
### Consumer
Κατευθυνόμαστε στο φάκελο MyConsumer και ανοίγουμε ένα τερματικό.
In the folder MyConsumer open a terminal computer.
Στη συνέχεια τρέχουμε την εντολή:
Then, run the command:
docker build -t myconsumer .
docker build -t myconsumer .
Η συγκεκριμένη εντολή θα δημιουργήσει ένα **docker image** το οποίο περιέχει ότι χρειάζεται το script consumer.js για να τρέξει.
This command will create a **docker image** with the info needed to run the script consumer.js.
Στη συνέχεια μπορούμε να τρέξουμε την εντολή:
Then, run the command:
docker run -it -p 5673:5673 myconsumer
docker run -it -p 5673:5673 myconsumer
Για να σηκώσουμε έναν **container** απο το συγκεκριμένο **image** για την υπηρεσία του **consumer**.
To compose a **container** from the **image** for the **consumer** service.
> Όπως φαίνεται απο την εντολή **run** κάνουμε **expose** τη πόρτα
> As shown in the command **run** we **expose** the port
> **5673**απο τον υπολογιστή μας στην πόρτα **5673** του**container**.
> **5673**from the computer to the port **5673** of the**container**.
Τέλος ελέγχουμε αν ο container τρέχει με την εντολή:
Finally, we check if the container run using the command:
docker ps
docker ps
### Server
### Server
Την ίδια διαδικασία ακολουθούμε και για την υπηρεσία του**server**.
We use the same proceduce for the**server**.
Κατευθυνόμαστε στο φάκελο MyServer και ανοίγουμε ένα τερματικό.
We go to the folder MyServer upon we startup a terminal.
Στη συνέχεια τρέχουμε την εντολή:
Then, we run the command:
docker build -t atticaregionserver .
docker build -t atticaregionserver .
Η συγκεκριμένη εντολή θα δημιουργήσει ένα **docker image** το οποίο περιέχει ότι χρειάζεται το script server.js για να τρέξει.
This particular command will create a **docker image** with the info needed to run the script server.js.
Στη συνέχεια μπορούμε να τρέξουμε την εντολή:
Then, we run the command:
docker run -it -p 4000:4000 atticaregionserver
docker run -it -p 4000:4000 atticaregionserver
Για να σηκώσουμε έναν **container** απο το συγκεκριμένο **image** για την υπηρεσία του **server**.
To compose a **container** from the **image** for the **server** service.
> Όπως φαίνεται απο την εντολή **run** κάνουμε **expose** τη πόρτα
> As shown in the command **run** we **expose** the port
> **4000**απο τον υπολογιστή μας στην πόρτα **4000** του**container**.
> **4000**from the computer to the port **4000** of the**container**.
Τέλος ελέγχουμε αν ο container τρέχει με την εντολή:
Finally, we check if the container run using the command:
docker ps
docker ps
### RabbitMQ
### RabbitMQ
Η επόμενη υπηρεσία που θα χρειαστούμε είναι ο**RabbitMQ broker**(AMQP).
The next needed service is**RabbitMQ broker**(AMQP).
Απο όλες τις λειτουργίες του **RabbitMQ** (fanout κτλπ) εμείς θα χρησιμοποιήσουμε την**Direct exchange**.
Of its functions **RabbitMQ** (fanout, token routing, etc) we will use the**Direct exchange**.
Μπορούμε απο εδώ να κάνουμε **overview** την διαδικασία του **produce** και **consume** βλέποντας τα γραφήματα, τις ταχύτητες **consume** και **produce** στο **tab Queues** , τα **connection** που έχουμε και τα **channels**.
Now, we are able to **overview** the process of **produce** and **consume** using the graphs, the speed of **consume** and **produce** to the **tab Queues** , the **connection** and the **channels**.
Επιπλέον μπορούμε αν θέλουμε να φτιάξουμε έναν δικό μας χρήστη στο **tab Admin**.
Further, we are able to create a new user to the **tab Admin**.
H διαδικασία είναι η εξής:
1) Μεταβένουμε στο tab Admin.
2) Στο **drop down menu Add a User** βάζουμε τα στοιχεία που επιθυμούμε , στην επιλογή **Tag** επιλέγουμε **Admin** και πατάμε το κουμπί **Add User**.
3) Στη συνέχεια επιλέγουμε τον χρήστη που φτιάξαμε και το **panel Set permission**, στην επιλογή **Virtual Host** επιλέγουμε **"/"** ώστε να γίνει **admin** ο χρήστης και πατάμε το κουμπί **Set permission**.
### Grafana & InfluxDB
### Grafana & InfluxDB
Σε αυτό το σημείο εκτός απο τα **images** του **Grafana** και της **InfluxDB** θα χρειαστούμε και ένα **δίκτυο** προκειμένου να μπορεί να δει αυτόματα το **Grafana** τη βάση.
At this point, except of the **images** of **Grafana** and of **InfluxDB** we will need a **network** in order **Grafana** to automatically detect the database.
Η δομή που θέλουμε να πετύχουμε είναι η παρακάτω:
The structure we will use to obtain it is the following:
Όπως φαίνεται και στο παραπάνω αρχείο με το **yml file** σηκώνονται δυο **containers(InfluxDB,Grafana)** οι οποίοι χρησιμοποιούν το κοινό **bridge network** και τα **volumes.**
As shown to the file above with the **yml file** compose two **containers(InfluxDB,Grafana)** for using the common network **bridge network** and the corresponding **volumes**.
Εφόσον σηκωθούν οι containers με την εντολή:
Upon composing the containers using the command:
docker exec -it influxdb_container sh
docker exec -it influxdb_container sh
Μπορούμε να πάρουμε **shell** μέσα στον container της**InfluxDB**.
We are able to access the **shell** in the container of the**InfluxDB**.
Αμέσως μετά πληκτρολογούμε **influx** για να μεταβούμε στο **shell** της**InfluxDB**.
Then, we type **influx** to go to **shell** of the**InfluxDB**.
Απο τα αρχεία του κώδικα θα παρουσιαστούν **τα πιο σημαντικά σημεία του** με σκοπό την κατανόηση του τρόπου λειτουργίας (όχι δηλώσεις μεταβλητών κτλπ).
2) Δημιουργία connection, channel και queue για το RabbitMQ
3) Ανάγνωση της σειριακής θύρας
4) Δημιουργεία ενός κενού javascript object με σκοπό να το γεμίσουμε με το όνομα του αισθητήρα και της τιμή που διαβάστηκε απο την σειριακή πόρτα (εφαρμογή της μεθόδου slice για να κόψουμε το "\r" απο τα δεδομένα που διαβάζονται στην σειριακή πόρτα).
5) Μετατροπή του javascript object σε JSON αποστολή του στη queue (JSON γιατί είναι απαιτούμενο του RabbitMQ).
1) Αρχικοποίηση των ρυθμίσεων της βάσης με σκοπό να μπορώ να γράψω και να διαβάσω απο αυτή.
Οι τιμές που καταγράφονται στη βάση έχουν το measurement temp , είναι τύπου float και περιγράφονται απο το tag sensor (θα μπορούσε το tag να έχει πολλές τιμές π.χ. building1 , floor2 , room55 με σκοπό να προσδιορίσουμε ακριβώς τη θέση της προερχόμενης τιμής).
2) Αρχικοποίηση των ρυθμίσεων του RabbitMQ ώστε να ξέρω απο που θα πάρω τα δεδομένα μου (που να γίνει το consume from queue).
1) **(6)** ανά 5 λεπτά γίνεται ένα query στη βάση και επιστρέφει όλες τις τιμές των τελευταίων 5 λεπτών.
2) Αποθήκευση τιμών σε ένα array.
3) Προσπέλαση όλου του array.
4) Έλεγχος των τιμών ανά ζευγάρια των δύο και υπολογισμός αν υπάρχει ποσοστιαία αύξηση ή μείωση αντίστοιχα μεταξύ των τιμών. Αν υπάρχει , τροποποιείται σε αντίστοιχη μορφή το κείμενο του mail.
