Skip to content

Latest commit

 

History

History
105 lines (66 loc) · 5.63 KB

readme.md

File metadata and controls

105 lines (66 loc) · 5.63 KB
Raw

Web based ChatGPT-Arduino Interface

Connect ChatGPT to the physical world!

This project enables you to connect ChatGPT with an Arduino using Bluetooth Low Energy (BLE) or Serial via a webapp in a Chrome browser. In the future we may add other options for connections like MQTT.

The web app needs to stay open while using the device. This has the advantage of providing a simple interface for talking to chatgpt and testing quick prototypes. If you need something to work on Arduino independently of a desktop computer, try this ChatGPT client for Arduino, or this Arduino Cloud example.

Features

  • ChatGPT Integration: Connects ChatGPT with an Arduino, enabling you to send commands and receive responses via BLE.

  • Web App Interface: The project includes a web app that you can access using the Chrome browser. The web app communicates with the Arduino through the BLE Web API. The app is built with vanilla JS and requires no compiling to run.

Prerequisites

Before you begin, ensure you have the following:

  • Google Chrome browser (required for accessing the BLE Web API and Serial Web API). Some other modern browser may also support these features

  • For BLE examples, an Arduino board that supports BLE (e.g., Arduino Wifi uno rev 2)

Installation

  1. Clone this repository to your local machine, and run the web app on a local server.
  2. Flash one of the Arduino example using the Arduino IDE. (see more information below)

Web app.

You'll need to set up a couple of things up before the web app will work, and you will need a chatGPT API key.

  1. Create a file called "chatGPTkey.js" in the /js directory of the webapp. Inside this file, add the line:
const OPENAI_API_KEY = 'PUT YOUR API KEY HERE'; // never share this or publish online!
  1. Run the webapp on a local server.
  2. Open the webapp in Chrome and ask ChatGPT to connect to the remote device.
  3. ChatGPT is now connected to the physical world!

Next you will want to modify the example to give ChatGPT a unique personality or rules to control its behaviour. Check out the best practice guide in the API documentation for more tips.

  1. Open the config.js file
  2. Change the system text to modify the behaviour of the chatbot.
  3. Each request to the API sends all of the system instructions and message history, so keep the length of instructions to minimal to avoid exceeding the token quota.

Custom Functions

  1. You can add custom functions to ChatGPT by editing the file JsFunctions.js. These functions will be available to ChatGPT to use. There're two pre-defined functions: start_party and star_pressed. The first function is an example function that will be executed on the Arduino, the second function is an example function that will be executed in the browser.
  2. Use config.js to set the list of functions that ChatGPT can use. Inside of local_functionList you can add new functions and descriptions.

Arduino

Currently the ArduinoBLE library is extremely bloated. We have have good experience using version 1.1.1 which is fairly light, together with the wifiNina firmware version 1.5.

For BLE:

  1. Update your firmware for the wifiNina to 1.5
  2. Upload the example code to the Arduino.
  3. Modify the example for your own project: most of your code should be in loopGPT, which will be called when BLE is connected.

How it works

The whole process is based on the "function calling" feature of the ChatGPT api. In response to a prompt, the API can either send you a message or call to a predefined function. If the API sends a function call, it expects to get a response with the return value from the function. It then uses this response to formulate a new message, or to decide to make additional function calls.

The web app handles the routing of these function calls to the Arduino connected via Serial or BLE.

Notify events

The Arduino can talk directly to chatGPT without anything needed to be typed in the web app. This works by programing events on the arduino to send information to chatGPT.

In BLE mode, this is done with a characteristic, which is simply a data item exposed over BLE to readable and/or writable from an other device. The browser will subscribe to any characteristic listed in Config.js, and if there is a an event it will relay the information to chatGPT.

This Serial mode, this is simply done with the notify() command.

Be careful how often these events are fired. It will take ChatGPT a couple of seconds to respond to each event, so you don't want to be firing these events very frequently.

    int sensorValue = analogRead(A0);
    if (sensorValue >= 500) {
      sensorCharacteristic.writeValue(sensorValue);  
      Serial.println("sensorValue notify!");
      delay(2000); //  delay here to prevent event happening too often.
    }

A delay like this is simple and will work, but it blocks your arduino code for 2 whole seconds!

A better option looks like this:

unsigned long previousMillis = 0;  

void loopGPT() {
  unsigned long currentMillis = millis();
  int sensorValue = analogRead(A0);
if (sensorValue >= 500 && currentMillis - previousMillis >= 2000) {
      sensorCharacteristic.writeValue(sensorValue);  
      Serial.println("sensorValue notify!");
      previousMillis = currentMillis
  } 
}