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 (⁠づ⁠￣⁠ ⁠³⁠￣⁠)⁠づ

*the animation is from ENA BBQ series by JoelG

Tools that are required

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

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

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

4. If the board is connected try to open the client page in https://localhost:3000/

   

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

  npm run ports

  > [email protected] ports
  > ts-node src/ports/print.ts
  
  3 Ports available
  1. /dev/ttyUSB0
  2. /dev/ttyUSB1
  3. /dev/ttyACM0
  

• Common HTTP Responses
• JSON Response
• Example Request
• Digital
  • Digital Read
  • Digital Write
• Analog
  • Analog Read
  • Analog Write
• PIN
  • Read PIN Mode
  • Set PIN Mode
• LED
  • Read LED state
  • Set LED state
• RGB LED
  • Read RGB state
  • Set RGB state
• Piezo
  • Piezo Tone
  • Piezo Note
  • Piezo Play Music

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

{
    "status": 200,
    "pin_state": {
        "13": "HIGH"
    },
    "message": "Changed pin state 13 to HIGH"
}

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

Using curl

curl -X PATCH http://localhost:3000/api-arduino/led/13/on

Using fetch async/await javascript

async function turnOnLed() {
    const res = await fetch("http://localhost:3000/api-arduino/led/13/on", { method: 'PATCH' }); // Set LED to HIGH
    const data = await res.json();
    console.log(data); // { status: 200, pin_state: { 13: high }, message: "Pin 13 Set to HIGH" }
}

• URL Endpoint

  /api-arduino/digital/:pin

• URL Params

  Params	Mark	Type	Required	Description
  pin	pin	string	true	Seleced pin

• Method

  GET

• Example Request

  fetch("http://localhost:3000/api-arduino/digital/13")
      .then(res => res.json())
      .then(res => console.log(res))
      .catch(err => console.error('error', err));

• Example Response

  {
      "status": 200,
      "pin_state": {
          "13": "HIGH"
      }
  }

• URL Endpoint

  /api-arduino/digital

• Body

  {
      pin: number,
      state: 'HIGH' | 'LOW' | 1 | 0 | string
  }

• Method

  PATCH

• Example Request

  var data = {
      pin: 13,
      state: 'LOW'
  }
  
  var options = {
      method: 'PATCH',
      body: JSON.stringify(data),
      headers: {
          'Content-Type': 'application/json'
      },
      redirect: 'follow'
  }
  
  fetch("http://localhost:3000/api-arduino/digital", options)
      .then(res => res.json())
      .then(res => console.log(res))
      .catch(err => console.error('error', err));

• Example Response

  {
      "status": 200,
      "pin_state": {
          "13": "HIGH"
      }
  }

• URL Endpoint

  /api-arduino/analog/:p

• URL Params

  Params	Mark	Type	Required	Description
  pin	pin	string	true	Seleced pin

• Method

  GET

• Example Request

  fetch("http://localhost:3000/api-arduino/analog/A0")
      .then(res => res.json())
      .then(res => console.log(res))
      .catch(err => console.error('error', err));

• Example Response

  {
      "status": 200,
      "analog_state": {
          "A0": 1023
      }
  }

• URL Endpoint

  /api-arduino/analog

• Body

  {
      pin: string | number,
      value: number
  }

• Method

  PATCH

• Example Request

  var data = {
      pin: 'A0',
      value: 1023
  }
  
  var options = {
      method: 'PATCH',
      body: JSON.stringify(data),
      headers: {
          'Content-Type': 'application/json'
      },
      redirect: 'follow'
  }
  
  fetch("http://localhost:3000/api-arduino/analog", options)
      .then(res => res.json())
      .then(res => console.log(res))
      .catch(err => console.error('error', err));

• Example Response

  {
      "status": 200,
      "pin_state": {
          "13": 1023
      }
  }

• URL Endpoint

  /api-arduino/pin/:p/

• URL Params

  Params	Mark	Type	Required	Description
  p	pin	string	true	Seleced pin

• Method

  GET

• Example Request

  fetch("http://localhost:3000/api-arduino/pin/13")
      .then(res => res.json())
      .then(res => console.log(res))
      .catch(err => console.error('error', err));

• Example Response

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

• URL Endpoint

  /api-arduino/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

  PATCH

• Example Request

  fetch("http://localhost:3000/api-arduino/pin/13/output", { method: 'PATCH' })
      .then(res => res.json())
      .then(res => console.log(res))
      .catch(err => console.error('error', err));

• Example Response

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

• URL Endpoint

  /api-arduino/led/:p/

• URL Params

  Params	Mark	Type	Required	Description
  p	pin	string	true	Seleced pin

• Method

  GET

• Example Request

  fetch("http://localhost:3000/api-arduino/led/13")
      .then(res => res.json())
      .then(res => console.log(res))
      .catch(err => console.error('error', err));

• Example Response

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

• URL Endpoint

  /api-arduino/led/:p/:a

• URL Params

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

• Method

  PATCH

• Example Request

  fetch("http://localhost:3000/api-arduino/led/13/output", { method: 'PATCH' })
      .then(res => res.json())
      .then(res => console.log(res))
      .catch(err => console.error('error', err));

• Example Response

  {
      "status": 200,
      "pin_state": {
          "13": "HIGH"
      },
      "message": "Changed pin state 13 to HIGH"
  }

• URL Endpoint

  /api-arduino/rgb-led

• Body

  {
      r: number,
      g: number,
      b: number
  }

• Method

  POST

• Example Request

  var data = {
      r: 7,
      g: 6,
      b: 5
  }
  
  var options = {
      method: 'POST',
      body: JSON.stringify(data),
      headers: {
          'Content-Type': 'application/json'
      },
      redirect: 'follow'
  }
  
  fetch("http://localhost:3000/api-arduino/rgb-led", options)
      .then(res => res.json())
      .then(res => console.log(res))
      .catch(err => console.error('error', err));

• Example Response

  {
      "status": 200,
      "pin_state": {
          "7": true,
          "6": true,
          "5": false
      }
  }

• URL Endpoint

  /api-arduino/rgb-led

• Body

  {
      r: {
          pin: number,
          value: boolean
      },
      g: {
          pin: number,
          value: boolean
      },
      b: {
          pin: number,
          value: boolean
      }
  }

• Method

  PATCH

• Example Request

  var data = {
      r: {
          pin: 7,
          value: true
      },
      g: {
          pin: 6,
          value: true
      },
      b: {
          pin: 5,
          value: false
      }
  }
  
  var options = {
      method: 'PATCH',
      body: JSON.stringify(data),
      headers: {
          'Content-Type': 'application/json'
      },
      redirect: 'follow'
  }
  
  fetch("http://localhost:3000/api-arduino/rgb-led", options)
      .then(res => res.json())
      .then(res => console.log(res))
      .catch(err => console.error('error', err));

• Example Response

  {
      "status": 200,
      "pin_state": {
          "7": true,
          "6": true,
          "5": false
      },
      "message": "Success changed pins 7, 6, 5 to state HIGH, HIGH, LOW"
  }

• URL Endpoint

  /api-arduino/piezo/:p/:f

• URL Params

  Params	Mark	Type	Required	Description
  p	pin	string	true	Seleced pin
  f	frequency	number	true	Frequency

• Method

  PATCH

• Example Request

  fetch("http://localhost:3000/api-arduino/piezo/6/300", { method: 'PATCH' })
      .then(res => res.json())
      .then(res => console.log(res))
      .catch(err => console.error('error', err));

• Example Response

  {
      "status": 200,
      "pin_tone": {
          "6": 300
      },
      "message": "Piezo 6 tone 300"
  }

• URL Endpoint

  /api-arduino/piezo/note

• Body

  {
      pin: number,
      note: string
  }

• Method

  PATCH

• Example Request

  var data = {
      pin: 6,
      note: "B3"
  }
  
  var options = {
      method: 'PATCH',
      body: JSON.stringify(data),
      headers: {
          'Content-Type': 'application/json'
      },
      redirect: 'follow'
  }
  
  fetch("http://localhost:3000/api-arduino/piezo/note", options)
      .then(res => res.json())
      .then(res => console.log(res))
      .catch(err => console.error('error', err));

• Example Response

  {
      "status": 200,
      "pin_tone": {
          "6": 247
      },
      "pin_note": {
          "6": "B3"
      },
      "message": "Piezo 6 tone note B3"
  }

• URL Endpoint

  /api-arduino/piezo/music

• Body

  {
      pin: number,
      notes: string[],
      beats: number,
      tempo: number
  }

  Example

  {
      pin: 6,
      notes: ["F4", "G4", "F4", "G4"],
      beats: 1/4,
      tempo: 100
  }

• Method

  PATCH

• Example Request

  var data = {
      pin: 6,
      notes: ["E4", "E4", "F4", "G4", "G4", "F4", "E4", "D4", "C4", "C4", "D4", "E4", "D4", "-", "C4", "C4"], // ode to joy notes
      beats: 1/2,
      tempo: 100
  }
  
  var options = {
      method: 'PATCH',
      body: JSON.stringify(data),
      headers: {
          'Content-Type': 'application/json'
      },
      redirect: 'follow'
  }
  
  fetch("http://localhost:3000/api-arduino/piezo/music", options)
      .then(res => res.json())
      .then(res => console.log(res))
      .catch(err => console.error('error', err));

• Example Response

  {
      "status": 200,
      "pin_notes": {
          "6": [ "E4", "E4", "F4", "G4", "G4", "F4", "E4", "D4", "C4", "C4", "D4", "E4", "D4", "-", "C4", "C4" ]
      },
      "message": "Piezo 6 play notes E4, E4, F4, G4..."
  }