Image of air conditioner

Smart AC is a backend system designed to integrate with remote air conditioning units. It is comprised of three main services

• Registration - handles authentication of remote AC units,provide tokens for the web API, and maintains state of registered devices
• SensorReadingDataHub - provides API endpoints for air conditioners to report their data readings and supplies them to other services
• Administration - generates alerts on reported data and allows admins to resolve them

All three services are hosted in an ASP.net app, which also hosts an administration web portal. This web app is the main is the entryway to the application (see "Running the app" below).

Image of services diagrom

• .NET SDK 5
• Any 32-bit encryption key

• Clone the repo and navigate to the Web project in the repo
• Set the AppSettings__EncryptionKey app setting to your encryption key. You can do this a few ways
  • dotnet User secrets
    • when using this method, replace the "__" in the key with an ":" i.e. AppSettings:EncryptionKey
  • Environment variables
  • See the ASP.NET docs for more info

• dotnet build

The Web project can also be run in docker

cd /Web/build

build.ps1 -production [False|True] -key YOURENCRYPTIONKEY -certname YOURCERTNAME -certpw YOURCERTPASSWORD

• Your app will be reachable at http://localhost:8000

⚠ NOTE: to use docker locally with HTTPS, you will need to set up your self-signed certificate and provide it to the container. See the ASP.NET docs

cd ./src

dotnet test ⚠ NOTE: Testing framework is incomplete. Make sure you have the app reachable at https://localhost:8001 or the tests will fail

The available endpoints are documents with Swagger.

• Swagger UI: http://theorem-smart-ac.herokuapp.com/swagger/index.html
• Swagger JSON: http://theorem-smart-ac.herokuapp.com/swagger/v1/swagger.json

A brief explanation of the available endpoints:

POST ​/Authentication​/Authenticate

Authenticate remote device using device credentials. Returns authentication token

GET ​/Authentication​/Validate

Validate authentication token using the Authentication: Bearer header

POST /Registration/Register

Register a new device using device credentials. Return authentication token.

POST /Sensors/SubmitReading

Submit device sensor readings

Since this is a prototype application, there are some aspects that have been pared down or simulated.

• Databases is SQLite, which has limitations inherent to it's in-process architecture (e.g. speed)
• User sources are simulated very loosely
  • In the administration portal, any username/password will grant access
  • In the registration service, device serial numbers and secrets are hard coded on a file on disk
• All separate services are hosted by the same ASP.Net web application for ease of deployment and configuration
• There are no data verification or formatting restrictions beyond that of their underlying data type
• Data views in the web portal are arbitrarily limited to 50 records
• Common application functions such as error recovery, logging, and monitoring have been foregone
• The application is standalone and is not supported by other services such as a reverse proxy or container orchestrator
• There is no defined CI\CD process

made with 💙 by Brandon Alexander