agustin-q / wattapp-backend Goto Github PK

Sensor Loging API, Backend and Frontend

Home Page: https://wattapp-frontend.herokuapp.com/

JavaScript 100.00%

wattapp-backend's Introduction

⚡WattApp⚡

Sensor Logging API, Backend and Frontend

This is a project made for learning backend development, frontend development and IoT (Front end, hardware and firmware for the Logging sensor is in a separate repository).

Backend: https://wattapp-backend.herokuapp.com/api

Frontend: https://wattapp-frontend.herokuapp.com/

Frontend repo: https://github.com/Agustin-Q/WattApp-frontend

Arduino library repo: coming soon... 😁

Backend is built using Node.js and the following libraries:

express (https://www.npmjs.com/package/express)
NeDB (https://www.npmjs.com/package/nedb)
joi (https://www.npmjs.com/package/joi)
jsonwebtoken (https://www.npmjs.com/package/jsonwebtoken)

ToDo's 💪

User Data Scheme

{
  UserName: "myName",
  Password: "myPassword",
  Devices: [
    {
    DeviceName: "myDeviceName", 
    DeviceDescription: "deviceDescription",
    DeviceKey: "gRfgGHr4H54fghsfdg"
    Sensors:[
      {
      SensorIndex:0, // igual al index en el array
      SensorType:"sensorType",
      SensorUnit: "sensorUnit",
      },
    ]
    },
  ]
}

Adding a new user:

{
  UserName: "myName",
  Password: "myPassword",
  Devices: [
    {
    DeviceName: "myDeviceName", 
    DeviceDescription: "deviceDescription",
    DeviceKey: "gRfgGHr4H54fghsfdg"
    Sensors:[]
    },
  ]
}

{
  UserName: "myName",
  Password: "myPassword",
  Devices: [  ]
}

Sensor Data Scheme

{
  UserName:"myName", //added by server
  DeviceName: "myDeviceName",  //added by server
  SensorData: [
    {
    sensorIndex: 0,
    sensorName: "mySensor name", //added by server
    value: 1234,
    unit: "kW", //added by server
    timeStamp: 164855498
    },
    {
    sensorIndex: 1,
    sensorName: "my other sensor name", //added by server
    value: 1234,
    unit: "amps", //added by server
    timeStamp: 164855498
    },
  ],
  ServerTimeStamp: 1604190950 // added by the server
  }

Sensor data schema send by device:

{
  deviceKey: "gRfgGHr4H54fghsfdg",
  values: [
   {sensorIndex: 1, value:123, timeStamp:1601010515},
   {sensorIndex: 2, value:123, timeStamp:1601010515},
   {sensorIndex: 1, value:123, timeStamp:1601010515},
   ...
   {sensorIndex: 1, value:123, timeStamp:1601010515},
  ]
}

Recommend Projects