Comments

arduino/bus/uno/uno.ino

@@ -34,16 +34,23 @@ void startLCDTimeout()
   timeFromLastLCD = millis();
 }
 
+// LCD helper
 void writeOnLCD(int col, int row, String str)
 {
   lcd.setCursor(col, row);
   lcd.print(str);
 }
 
+/*
+  There's an animation when loading:
+  ".   " > "..  " > "... " > "...." (and repeat)
+  This function does it.
+*/
 void connectingDots(int msgCol, String msg)
 {
   if (!connecting || connectingAccum == 4)
   {
+    connecting = false;
     connectingAccum = 0;
     lcd.clear();
     writeOnLCD(msgCol, 1, msg);
@@ -54,6 +61,7 @@ void connectingDots(int msgCol, String msg)
   connecting = true;
 }
 
+// When a new message comes in the Serial, this runs
 void newWifiStatus(String wifiStatus)
 {
   if (wifiStatus.startsWith("viajes:"))
@@ -83,9 +91,9 @@ void newWifiStatus(String wifiStatus)
     startLCDTimeout();
   }
   else if (wifiStatus == "connected")
-    setLCDDefault();
-  else if (wifiStatus == "connecting")
-    connectingDots(3, "Arrancando");
+
+    else if (wifiStatus == "connecting")
+        connectingDots(3, "Arrancando");
   else if (wifiStatus == "connection-lost")
     connectingDots(2, "Reconectando");
 }
@@ -99,6 +107,7 @@ void setup()
 
 void loop()
 {
+  // Serial reader
   while (Serial.available() > 0)
   {
     serialAcum.concat(char(Serial.read()));
@@ -109,6 +118,11 @@ void loop()
     serialAcum = "";
   }
 
+  /*
+    Timeouts
+    LCD = 3s
+    Buzzer = .5s
+  */
   if (LCDTimeoutOn && millis() - timeFromLastLCD > 3000)
     setLCDDefault();
   if (BuzzerTimeoutOn && millis() - timeFromLastBuzzer > 500)

arduino/bus/wemos/wemos.ino

@@ -19,6 +19,7 @@ bool connecting = false;
 extern const unsigned char caCert[] PROGMEM;
 extern const unsigned int caCertLen;
 
+// HTTPS Request
 void useViaje(String UID)
 {
   client.print(String("") +
@@ -37,10 +38,15 @@ void useViaje(String UID)
       break;
   }
 
+  /*
+    '!' is because the responses are "viajes:2!", "error!", etc.
+    It is like that because of performance
+  */
   String res = client.readStringUntil('!');
   Serial.print(res);
 }
 
+// I don't know exactly how it works, but it works.
 String getUID()
 {
   String content = "";
@@ -93,6 +99,11 @@ void loop()
       Serial.print("connected");
     }
 
+    /*
+      So, "mfrcRecentlyUsed" exists because of some weirdness of the two functions below.
+      If I have my card in the scanner indefinitely, these function will return [true, false, true, false, true, ...].
+      "mfrcRecentlyUsed" bypass that :)
+    */
     if (mfrc522.PICC_IsNewCardPresent() && mfrc522.PICC_ReadCardSerial())
     {
       mfrcRecentlyUsed = true;

arduino/checker/uno/uno.ino

@@ -23,16 +23,23 @@ void startLCDTimeout()
   timeFromLastLCD = millis();
 }
 
+// LCD helper
 void writeOnLCD(int col, int row, String str)
 {
   lcd.setCursor(col, row);
   lcd.print(str);
 }
 
+/*
+  There's an animation when loading:
+  ".   " > "..  " > "... " > "...." (and repeat)
+  This function does it.
+*/
 void connectingDots(int msgCol, String msg)
 {
   if (!connecting || connectingAccum == 4)
   {
+    connecting = false;
     connectingAccum = 0;
     lcd.clear();
     writeOnLCD(msgCol, 1, msg);
@@ -43,6 +50,7 @@ void connectingDots(int msgCol, String msg)
   connecting = true;
 }
 
+// When a new message comes in the Serial, this runs
 void newWifiStatus(String wifiStatus)
 {
   if (wifiStatus.startsWith("res:"))
@@ -83,6 +91,7 @@ void setup()
 
 void loop()
 {
+  // Serial reader
   while (Serial.available() > 0)
   {
     serialAcum.concat(char(Serial.read()));
@@ -93,6 +102,10 @@ void loop()
     serialAcum = "";
   }
 
+  /*
+    Timeouts
+    LCD = 5s
+  */
   if (LCDTimeoutOn && millis() - timeFromLastLCD > 5000)
     setLCDDefault();
 

arduino/checker/wemos/wemos.ino

@@ -19,6 +19,7 @@ bool connecting = false;
 extern const unsigned char caCert[] PROGMEM;
 extern const unsigned int caCertLen;
 
+// HTTPS Request
 void useViaje(String UID)
 {
   client.print(String("") +
@@ -36,10 +37,15 @@ void useViaje(String UID)
       break;
   }
 
+  /*
+    '!' is because the responses are "viajes:2!", "error!", etc.
+    It is like that because of performance
+  */
   String res = client.readStringUntil('!');
   Serial.print(res);
 }
 
+// I don't know exactly how it works, but it works.
 String getUID()
 {
   String content = "";
@@ -92,6 +98,11 @@ void loop()
       Serial.print("connected");
     }
 
+    /*
+      So, "mfrcRecentlyUsed" exists because of some weirdness of the two functions below.
+      If I have my card in the scanner indefinitely, these function will return [true, false, true, false, true, ...].
+      "mfrcRecentlyUsed" bypass that :)
+    */
     if (mfrc522.PICC_IsNewCardPresent() && mfrc522.PICC_ReadCardSerial())
     {
       mfrcRecentlyUsed = true;

arduino/control-center/uno/uno.ino

@@ -5,6 +5,7 @@
 #define RST_PIN 9
 MFRC522 mfrc522(SS_PIN, RST_PIN); // Create MFRC522 instance.
 
+// I don't know exactly how it works, but it works.
 String getUID()
 {
   String content = "";

control-center/main.js

@@ -63,6 +63,7 @@ function sendPorts() {
 ipcMain.on('get-ports', sendPorts)
 
 ipcMain.on('use-port', (e, port) => {
+  // An event listener to Serial
   const serial = new SerialPort(port, { baudRate: 115200 })
   const parser = serial.pipe(new Readline())
 

control-center/src/components/PortSelector.js

@@ -9,6 +9,7 @@ export default ({ setPortSetted }) => {
 
   useEffect(() => {
     ipcRenderer.on('ports', (_, portsRes) => {
+      // We don't like COM1
       portsRes = portsRes.filter(port => port.comName !== 'COM1')
       setPorts(portsRes)
       if (portsRes.length > 0) setPortSelected(portsRes[0].comName)

control-center/utils/listeners.js

@@ -1,12 +1,14 @@
 const path = require('path'),
   fetch = require('node-fetch'),
-  { ApolloClient, HttpLink, InMemoryCache, gql } = require('apollo-boost'),
+  { ApolloClient, HttpLink, InMemoryCache } = require('apollo-boost'),
+  queries = require('./queries'),
   isDev = require('electron-is-dev')
 
 require('dotenv').config({
   path: path.resolve(__dirname, `../.env${isDev ? '.test' : ''}`),
 })
 
+// Apollo Client
 const client = new ApolloClient({
   link: new HttpLink({
     uri: `${process.env.BASE_URL}/api/graphql`,
@@ -18,53 +20,6 @@ const client = new ApolloClient({
   cache: new InMemoryCache(),
 })
 
-const queries = {
-  getUser: gql`
-    query($id: ID, $uid: String, $dni: Int) {
-      user(id: $id, uid: $uid, dni: $dni) {
-        id
-        uid
-        dni
-        viajes
-      }
-    }
-  `,
-  getPrices: gql`
-    query {
-      metadata {
-        pasePrice
-        viajePrice
-      }
-    }
-  `,
-  addViajes: gql`
-    mutation($id: ID, $newViajes: Int!) {
-      addViajes(id: $id, newViajes: $newViajes)
-    }
-  `,
-  createUser: gql`
-    mutation($uid: String!, $dni: Int!) {
-      createUser(uid: $uid, dni: $dni) {
-        id
-      }
-    }
-  `,
-  updateUser: gql`
-    mutation($id: ID!, $uid: String!, $dni: Int!, $viajes: Int!) {
-      updateUser(id: $id, uid: $uid, dni: $dni, viajes: $viajes) {
-        id
-      }
-    }
-  `,
-  updatePrices: gql`
-    mutation($pasePrice: Int!, $viajePrice: Int!) {
-      updateMetadata(pasePrice: $pasePrice, viajePrice: $viajePrice) {
-        id
-      }
-    }
-  `,
-}
-
 const sendStatusError = (err, e) => {
   e.reply('status', {
     type: 'ERROR',
@@ -73,6 +28,7 @@ const sendStatusError = (err, e) => {
 }
 
 module.exports = ipcMain => {
+  // Yep, there's a lot of listeners
   ipcMain.on('get-user', (e, variables) =>
     client
       .query({ query: queries.getUser, variables })

control-center/utils/queries.js

@@ -0,0 +1,48 @@
+const { gql } = require('apollo-boost')
+
+module.exports = {
+  getUser: gql`
+    query($id: ID, $uid: String, $dni: Int) {
+      user(id: $id, uid: $uid, dni: $dni) {
+        id
+        uid
+        dni
+        viajes
+      }
+    }
+  `,
+  getPrices: gql`
+    query {
+      metadata {
+        pasePrice
+        viajePrice
+      }
+    }
+  `,
+  addViajes: gql`
+    mutation($id: ID, $newViajes: Int!) {
+      addViajes(id: $id, newViajes: $newViajes)
+    }
+  `,
+  createUser: gql`
+    mutation($uid: String!, $dni: Int!) {
+      createUser(uid: $uid, dni: $dni) {
+        id
+      }
+    }
+  `,
+  updateUser: gql`
+    mutation($id: ID!, $uid: String!, $dni: Int!, $viajes: Int!) {
+      updateUser(id: $id, uid: $uid, dni: $dni, viajes: $viajes) {
+        id
+      }
+    }
+  `,
+  updatePrices: gql`
+    mutation($pasePrice: Int!, $viajePrice: Int!) {
+      updateMetadata(pasePrice: $pasePrice, viajePrice: $viajePrice) {
+        id
+      }
+    }
+  `,
+}

web/next.config.js

@@ -7,6 +7,7 @@ const isDev = process.env.NODE_ENV !== 'production'
 module.exports = withSass(
   withOffline({
     webpack: config => {
+      // Aliases that let you do "import component from 'components'" instead of "import component from '../components'"
       config.resolve.alias['pages'] = path.join(__dirname, 'src/pages')
       config.resolve.alias['components'] = path.join(
         __dirname,

web/src/pages/api/checker.js

@@ -1,4 +1,4 @@
-const { text, send } = require('micro')
+const { text } = require('micro')
 const { prisma } = require('prisma')
 
 module.exports = async (req, res) => {

web/src/pages/api/graphql/resolvers.js

@@ -5,6 +5,12 @@ const checkAuth = authed => {
   if (!authed) throw new AuthenticationError('Inavlid Secret')
 }
 
+/*
+  Read slowly, because Prettier don't allow me to use enters :c
+  
+  "checkAuth" checks if authed (which is validated in the context function in 'index.js')
+*/
+
 export default {
   Query: {
     user: async (_, { id, uid, dni }) => await prisma.user({ id, uid, dni }),

web/src/pages/api/use-viaje.js

@@ -1,4 +1,4 @@
-const { text, send } = require('micro')
+const { text } = require('micro')
 const { prisma } = require('prisma')
 
 module.exports = async (req, res) => {