https://github.com/vidundergunder/hello-twin
Backend and microcontroller part of a "Hello World!" for digital twins.
https://github.com/vidundergunder/hello-twin
arduino digital-twin express influxdb javascript node python typescript
Last synced: 27 days ago
JSON representation
Backend and microcontroller part of a "Hello World!" for digital twins.
- Host: GitHub
- URL: https://github.com/vidundergunder/hello-twin
- Owner: VidunderGunder
- Created: 2021-04-16T20:38:08.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-28T21:51:33.000Z (about 2 years ago)
- Last Synced: 2025-02-05T12:13:17.683Z (3 months ago)
- Topics: arduino, digital-twin, express, influxdb, javascript, node, python, typescript
- Language: TypeScript
- Homepage:
- Size: 88.9 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hello Twin (Backend + MCU)
[Video](https://youtu.be/S07OMZwGjOs)
Backend and microcontroller part of a minimum digital twin example.
[Unity part here](https://github.com/VidunderGunder/hello-twin-unity)
## Table of Contents
- [Requirements](#requirements)
- [Quickstart](#quickstart)
- [Arduino and VSCode](#arduino-and-vscode)
- [Python (not needed for server)](#python-not-needed-for-server)
- [InfluxDB](#influxdb)
- [Node](#node)
- [Heads-Up](#heads-up)
## Requirements
- [x] Computer
- [x] Arduino UNO
- [x] Internet
## Quickstart
### Arduino and VSCode
Install [VSCode](https://code.visualstudio.com/)
Install [Arduino IDE](https://www.arduino.cc/en/software)
Open VSCode
Install recommended extensions (most importantly [Arduino](https://marketplace.visualstudio.com/items?itemName=vsciot-vscode.vscode-arduino))
Run `Arduino: Board Config`
Choose Arduino UNO (or the type you have on hand)
Run `Arduino: Select Serial Port` and choose your Arduino's port
*Remember the port, as we'll need it later*
Open `DemoTwin.ino`
Run `Arduino: Initialize`
Upload `DemoTwin.ino` to your board
Run `Arduino: Change Baud Rate` and ensure it's set to `115200`
Run `Arduino: Open Serial Monitor`
If successful, you should be able to run `Arduino: Send Text to Serial Port`, and turn the LED on and off by sending `H` and `L`
Run `Arduino: Close Serial Monitor`
### Python (not needed for server)
Install [Anaconda](https://www.anaconda.com/products/individual) (or any variant you prefer)
Open up your terminal, and run these commands:
```shell
conda create --name arduino python=3.7
```
```shell
conda activate arduino
```
```shell
conda install pyserial
```
Choose the new Arduino environment as the default Python interpreter in VSCode, by running `Python: Select Interpreter`.
Create a file in the project root called `.env`.
Set the correct COM-port in `.env` (`COM5` in my case), like so:
```env
COM="COM5"
```
Open `serial_test.py` in VSCode.
Run cell by cell with IPython.
### InfluxDB
[Create a free InfluxDB-account](https://cloud2.influxdata.com/signup)
Choose Azure as your bucket if prompted and you're not sure.
Go to `Data -> Buckets` and press `Create Bucket`.
*Note: `Load Data`, `Data` and `Load your data` are equivalent.*
Call it `HelloTwin Bucket`.
Go to `Data -> Tokens` and press `Generate Token`, and pick `Read/Write Token`.
Set description as `HelloTwin` and enable read and write access to `HelloTwin Bucket`.
Click on the token you created and `Copy to Clipboard`.
*Add* the following to your `.env`-file, with *your* info (can be found in all examples for loading data under `Data -> Client Libraries`):
```env
BUCKET="HelloTwin Bucket"
URL="https://your-thingy-thang.influxdata.com" # Replace
TOKEN="Th3T0k3nY0uJu5tC0pI3d" # Replace
ORG="[email protected]" # Replace
```
### Node
Add a port to your `.env`-file:
```env
PORT="8080"
```
Install [Node](https://nodejs.org/en/) (recommended version).
Install Yarn:
```shell
npm i -g yarn
```
Install dependencies:
```shell
yarn
```
Run development server:
```shell
yarn run dev
```
You'll likely get some errors - don't worry.
Open `src/index.ts` and save the file.
You can test queries with [Insomnia](https://insomnia.rest/download) (or [Postman](https://www.postman.com/downloads/), if you prefer).
## Heads-Up
If you get permission denied when doing anything COM-port related, make sure you close all active processes using the COM (e.g., Interactive Python or the Arduino Serial Monitor), and try again.
This project formats Python code with *black*, so accept installing it if prompted by VSCode, if you want auto-formatting.
In general, you should accept what VSCode recommends you to install, unless you know what you're doing.