lunar-vein-arduino/README.md

Lunar Vein: Arduino

A SIMPLE REST API based serial communication. Assisted Firmata protocol and johnny-five API, enabling software communication with the Arduino board using the Server API. that's it. Idk about electronics and networking actually. But that piece of knowledge motivated me to make some IoT stuff. Enjoy (⁠づ⁠￣⁠ ⁠³⁠￣⁠)⁠づ

Setup

Tools that are required

• Arduino Board
• Arduino IDE
• Node.js v16.0.0^ or other javascript runtime

Board

Arduino assembly guide also available in johnny-five documentation\

1. Plug in your Board via USB
2. Open Arduino IDE then select your Board
3. Go to File > Examples > Firmata Select StandarFirmataPlus
4. Upload the sketch

Server

1. Clone project and Install

   git clone https://github.com/norman-andrians/lunar-vein-arduino.git && cd lunar-vein-arduino
   npm i
   

2. Add .env file in the project root directory with the SERIAL_PORT variable

   SERIAL_PORT=/dev/ttyUSB0
   

3. Run the project

   npm start
   

Other scripts

• You can see what ports are connected to the device by running npm run ports script.

  npm run ports
  

  > lunar-vein-arduino@1.0.0 ports
  > ts-node src/ports/print.ts
  
  3 Ports available
  1. /dev/ttyUSB0
  2. /dev/ttyUSB1
  3. /dev/ttyACM0
  

API Documentation

Table of contents

• Common HTTP Responses
• JSON Response
• Example Request
• PIN
  • Read pin mode
  • Set pin mode
• LED
  • Read led state
  • Set led state

Common HTTP Responses

Some HTTP responses are sent with JSON, otherwise an HTML body will be sent which is the default express.js response

HTTP Status	Marks
200	The request act was successful
400	You may be making an invalid request, try to check the payload or recheck the documentation.
404	The resource wass not found
405	Method not allowed, servers usually only accept GET and PATCH methods
500	An error in the app server, if it continues please raise an issue or ask to contribute.

JSON Response

{
    "status": 200,
    "pin_state": {
        "13": "HIGH"
    },
    "message": "Pin 13 Set to HIGH"
}

Property	Description
status	HTTP Status code
pin_state	The state value of the pin that has been changed
message	Descriptive message of the changed state

Example Request

This is an example of javascript code sending a request to turn on the LED light, See LED API

async function turnOnLed() {
    const res = await fetch("http://localhost:3000/led/13/on"); // Set LED to HIGH
    const data = await res.json();
    console.log(data);
}

PIN

Read pin mode

• URL Endpoint

  /pin/:p/

• URL Params

  Params	Mark	Type	Required	Description
  p	pin	string	true	Seleced pin

• Method

  GET

• Sample Response

  {
      "status": 200,
      "pins": [
          {
              "pin": 13,
              "mode": "OUTPUT"
          }
      ],
      "message": "Pin 13 is OUTPUT"
  }
  

Set pin mode

• URL Endpoint

  /pin/:p/:m

• URL Params

  Params	Mark	Type	Required	Description
  p	pin	string	true	Seleced pin
  m	mode	'input', 'output', 'servo'	true	Pin Mode

• Method(s)

  PATCH

• Sample Response

  {
      "status": 200,
      "pins": [
          {
              "pin": 13,
              "mode": "OUTPUT"
          }
      ],
      "message": "Pin 13 setted as OUTPUT"
  }
  

LED

Read led state

• URL Endpoint

  /led/:p/

• URL Params

  Params	Mark	Type	Required	Description
  p	pin	string	true	Seleced pin

• Method

  GET

• Sample Response

  {
      "status": 200,
      "pin_state": {
          "13": "HIGH"
      },
      "message": "Led pin 13 is HIGH"
  }
  

Set led state

• URL Endpoint

  /pin/:p/:a

• URL Params

  Params	Mark	Type	Required	Description
  p	pin	string	true	Seleced pin
  a	act	'on', 'off'	true	Action

• Method(s)

  PATCH

• Sample Response

  {
      "status": 200,
      "pin_state": {
          "13": "HIGH"
      },
      "message": "Led pin 13 setted HIGH"
  }