Giters

JeremyTubongbanua / at_esp32

atPlatform implemented into the ESP32 microcontroller (Arduino C++)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

PlatformIO Registry

at_esp32

ESP32 C++ (Arduino framework) implementation of the atPlatform.

Installation

Learn how to add at_client as a dependency in your PlatformIO project. The atPlatform only supports the Arduino framework for the ESP32.

You can either go to PlatformIO Home and go to Libraries and search up at_client then click on "Add to Project", or simply:

Setup your platform.ini similar to:

[env:esp32dev]
platform = espressif32
board = esp32dev
framework = arduino
lib_deps = 
    jeremytubongbanua/at_client@^0.2.2
monitor_speed = 115200

Getting Started

1. Prerequisites

  1. Install VSCode and the PlatformIO VSCode extension.
  2. Get 2 atSigns and their .atKeys files. Follow this video to get your free atSign and generate its .atKeys file.
  3. You will need an ESP32 and a USB-A to micro-USB cable data cable to connect it to your computer.

2. Setting up your Project

  1. Open VSCode and install the PlatformIO VScode extension. You will use this extension to interact with the ESP32.
  2. Go to the PlatformIO Home (if you lost it just open the command palette via Ctrl/Cmd + Shift + P and search and run the PlatformIO: Home command).
  3. Install the Espressif32 platform by clicking on the Platforms > Embedded tab and searching for Espressif32 and clicking on the Install button.
  4. Next, go to Projects and press + Create New Project. Give a name to your project, select the Espressif ESP32 Dev Module board, and select the "Arduino" framework. Select a location for your project and click "Finish."
  5. Go back to the PlatformIO Home and click on the Libraries tab. Search for at_client by JeremyTubongbanua and click on the Install button. This will install the at_client library in your project. Do the same for the ArduinoJson library by Benoit Blanchon.
  6. Go to platform.ini and add the following line:
monitor_speed = 115200

3. Uploading your .atKeys

  1. Create a folder called data in the root of your project.
  2. Copy your .atKeys file into the data folder. The file should be in the data folder like data/@bob_key.atKeys
  3. Put your ESP32 into download mde by holding down the BOOT button and pressing the RESET button while still holding the BOOT button. It should be in download mode as long as you are holding BOOT down.
  4. While it is in download mode, run the "Upload File System Image" command. This can be seen under Project Tasks > Platform usually on top of where your file explorer is on VSCode. If you don't see your project tasks, you can open the command palette via Ctrl/Cmd + Shift + P and search and run the Project Tasks and try run the Explorer: and PlatformIO: recommended commands.
  5. Hopefully you get a [SUCCESS]. If you don't, make sure you are using a data USB-A to Micro USB cable (yes some cables don't transmit data). Also make sure the ESP32 is plugged in :) (it's happened before).

4. Building and Uploading your Project

  1. Open the main.cpp file in the src folder and add the following headers:
#include <WiFiClientSecure.h>
#include <SPIFFS.h>
#include "at_client.h"

  1. Run "Build" under "Project Tasks." If you don't see your project tasks, open the command palette via Ctrl/Cmd + Shift + P and search and run the Project Tasks and try run the Explorer: and PlatformIO: recommended commands.

  2. Hopefully you get a [SUCCESS].

  3. Now let's upload our project to the ESP32. First, put the ESP32 into download mode by holding down the BOOT button and pressing the RESET button while still holding the BOOT button. It should be in download mode as long as you are holding BOOT down. Run "Upload and Monitor" under "Project Tasks." If you don't see your project tasks, open the command palette via Ctrl/Cmd + Shift + P and search and run the Project Tasks and try run the Explorer: and PlatformIO: recommended commands.

5. Pkam Authentication

  1. Recall that each atSign has its own personal server known as an "atServer." You can just think of this as a key-value database but with a lot more features. The atServer speaks the atProtocol between clients and other atServers. Now let's write some code to allow our ESP32 to authenticate into its atServer so it can run operations.

  2. First let's create a constants.h header file under the include/ folder in our project. Let's define our WiFi SSID and Password. This can be your home WiFi or your own personal hotspot. Depending on your school, this may not work on your school WiFi.

// constants.h

#pragma once

#define SSID "******"
#define PASSWORD "******"
  1. Now let's include this header file into our main.cpp by including it like this:
/// ...
#include "constants.h"
/// ...
  1. Now let's add our pkam authentication code under the void setup() {} function like so:
void setup()
{
    // put your setup code here, to run once:

    // change this to the atSign you own and have the keys to
    const auto *at_sign = new AtSign("@24glad32"); 
    
    // reads the keys on the ESP32
    const auto keys = keys_reader::read_keys(*at_sign); 
    
    // creates the AtClient object (allows us to run operations)
    auto *at_client = new AtClient(*at_sign, keys);  
    
    // pkam authenticate into our atServer
    at_client->pkam_authenticate(SSID, PASSWORD); 
}

  1. Now put the ESP32 into download mode and upload and monitor your project.

  2. Your output should be similar to the snippet below. If it is not, ensure that the .atKeys are uploaded and that you are using the correct SSID and Password. It may take a few attempts to get it to work (perhaps due to weak connection). For Tyler, it took a few attempts to get it to work.

Attempting to connect to Soup...
..
Connected!
IP address: 2113972416
Connected to root.atsign.org:64
 ce749e70-f570-5486-9f86-eb9ec5e038d8.swarm0002.atsign.zone:5604
res: " ce749e70-f570-5486-9f86-eb9ec5e038d8.swarm0002.atsign.zone:5604"
Connected to ce749e70-f570-5486-9f86-eb9ec5e038d8.swarm0002.atsign.zone:5604
first: "@data:["publickey@24glad32","signing_publickey@24glad32"]"
Secondary connected: 1
challenge: "_def2da36-4c10-4b0e-97c1-f09c314637c2@24glad32:44fc42a6-774e-4bb8-bd6a-90d4c58b590a"
import: 0
complete: 0
private key check: 0
sign success: 0
pkam command: "pkam:VVw2RNcwhNw/l7vLLeC10VqNU2xqfUtjf7T82PvoxQ+uaN6QW9zj8Pi4+b8UgUNu6G8L1RkdmU2UMCkWrB/L0v2Jh1oK7eHth8PN4B91F/4rtxd1AGkfV+aiX5IyRLBC8prl5qdcqKqf3Gt6XCSV4/NDCOrXQqXdd/njZ/gmCLJlyPPlSu6IkOzMxu2nAcwNe7daSFw1agcyLLyhjdl3oJOopxGFX3zRar3vnex5F71A/1BIyP0h5OjZ0ZItngWaujMxEwwyvMINQJa0nflwk7z6phP+Vnt+7+oKNQCDhRfUTDaWHm4t++2Mp6BrHDh5KPCFCK9psgFGu+tx8nvpjg=="
response: success
authenticated: 1

6. Sending Data

In this step, your ESP32 will be sending data to the application.

  1. Before moving on, make sure you have successfully completed steps 1-5.

  2. Make sure that your application has send data to the ESP32 at least once before moving on.

package com.example;

import org.atsign.client.api.AtClient;
import org.atsign.common.AtException;
import org.atsign.common.AtSign;
import org.atsign.common.KeyBuilders;
import org.atsign.common.Keys.SharedKey;

public class App {
    public static void main(String[] args) throws Exception {
        AtSign java = new AtSign("@driving433");
        AtSign esp32 = new AtSign("@icy761");
        AtClient atClient = AtClient.withRemoteSecondary("root.atsign.org:64", java);

        // sending initial "handshake"
        SharedKey initialKey = new KeyBuilders.SharedKeyBuilder(atSign, esp32).key("test").build();

        String response = atClient.put(initialKey, "Hello World!").get();
        System.out.println("Response: " + response);
    }
}
  1. Back to ESP32 code, create a constants.h under the include/ folder and populate it with your SSID and PASSWORD.
#pragma once

#define SSID "****"
#define PASSWORD "****"
  1. Now let's code the main.cpp file. Copy the following code under void setup() {} and change constants accordingly to your project.
#include <Arduino.h>
#include <WiFiClientSecure.h>
#include <SPIFFS.h>
#include "at_client.h"

#include "constants.h"

void setup()
{
	// put your setup code here, to run once:

    // change this to the atSign you own and have the keys to
    const auto *at_sign = new AtSign("@esp"); 
	const auto *java = new AtSign("@java");
    
    // reads the keys on the ESP32
    const auto keys = keys_reader::read_keys(*at_sign); 
    
    // creates the AtClient object (allows us to run operations)
    auto *at_client = new AtClient(*at_sign, keys);  
    
    // pkam authenticate into our atServer
    at_client->pkam_authenticate(SSID, PASSWORD); 

	const auto *at_key = new AtKey("test", at_sign, java);

	at_client->put_ak(*at_key, "Hello World Lemonade!");
}

void loop()
{
	// put your main code here, to run repeatedly:
}
  1. Receive the data on the app side (Java example):
package com.example;

import org.atsign.client.api.AtClient;
import org.atsign.common.AtSign;
import org.atsign.common.KeyBuilders;
import org.atsign.common.Keys.SharedKey;

public class App {
    public static void main(String[] args) throws Exception {
        AtSign java = new AtSign("@driving433");
        AtSign esp32 = new AtSign("@icy761");
        AtClient atClient = AtClient.withRemoteSecondary("root.atsign.org:64", java);

        SharedKey sharedKey = new KeyBuilders.SharedKeyBuilder(esp32, java).key("test").build();

        String data = atClient.get(sharedKey).get();
        System.out.println("Data: " + data);
    }
}

7. Receiving Data

In this step, your ESP32 will be receiving data sent by the application.

  1. Before moving on, make sure you have successfully completed steps 1-5.

  2. Make sure that your application has sent data to the ESP32. Take note of the atSigns and the key name.

Sample java code:

package com.example;

import org.atsign.client.api.AtClient;
import org.atsign.client.util.EncryptionUtil;
import org.atsign.common.AtSign;
import org.atsign.common.KeyBuilders;
import org.atsign.common.Keys.AtKey;
import org.atsign.common.Keys.SharedKey;

/**
 * Hello world!
 *
 */
public class App {
    public static void main(String[] args) throws Exception {
        AtSign java = new AtSign("@driving433");
        AtSign esp32 = new AtSign("@icy761");


        AtClient atClient = AtClient.withRemoteSecondary("root.atsign.org:64", java, false);

        // SharedKey sharedKey = new KeyBuilders.SharedKeyBuilder(java, esp32).key("initialization").build();
        // String value = "hello there";

        // String ret = atClient.put(sharedKey, value).get();
        // System.out.println(ret);

        SharedKey sharedKey1 = new KeyBuilders.SharedKeyBuilder(esp32, java).key("test").build();
        String value1 = atClient.get(sharedKey1).get();

        System.out.println(value1);
    }
}
  1. Create a constants.h under the include/ directory. This file will contain your constants. Change them according to your WiFi SSID and Password.
#pragma once

#define SSID "****"
#define PASSWORD "****"
  1. Run the following code in main.cpp. Change your ESP32 atSign, Java atSign, key name, and optionally the value accordingly.
#include <Arduino.h>
#include <WiFiClientSecure.h>
#include <SPIFFS.h>
#include "at_client.h"

#include "constants.h"

void setup()
{
	// put your setup code here, to run once:

    // change this to the atSign you own and have the keys to
    const auto *esp32 = new AtSign("@esp"); 
	const auto *java = new AtSign("@java");
    
    // reads the keys on the ESP32
    const auto keys = keys_reader::read_keys(*esp32); 
    
    // creates the AtClient object (allows us to run operations)
    auto *at_client = new AtClient(*esp32, keys);  
    
    // pkam authenticate into our atServer
    at_client->pkam_authenticate(SSID, PASSWORD); 

	// key name is "test", 
	// sharedBy (creator) esp32 (@icy761), 
	// sharedWith java (@driving433)
	const auto *at_key = new AtKey("test", esp32, java); 

	const auto value = std::string{"Hello World!"};

	at_client->put_ak(*at_key, value);
}

void loop()
{
}

Resources

Core assets used in this project:

Contribute

  1. Open VSCode and install the PlatformIO VScode extension. You will use this extension to interact with the ESP32. Go to the PlatformIO Home (if you lost it just open the command palette and search and run the PlatformIO: Home command) and install the Espressif32 platform by clicking on the Platforms tab and searching for Espressif32 and clicking on the Install button.

  2. Make a fork of this repository and git clone it to your local machine.

git clone <YOUR_FORK_URL> <path
  1. Open the PlatformIO CLI by doing Ctrl (or Cmd) + Shift + P and run the PlatformIO: Open PlatformIO Core CLI command to open the CLI terminal. Then run the following command in the Platform CLI to initialize the .pio file.
pio project init
  1. Create a main.cpp file in the src folder and add the following code:

This will allow you to compile the code.

void setup() {};
void loop() {};
  1. Open the command palette with Ctrl (or Cmd) + Shift + P and run the PlatformIO: Build command to build the project. You should get no errors and the terminal should output a build successful. If you get an error, ensure you are executing the commands in the root of the project (the same folder as the platformio.ini file).

Any and all pull requests are appreciated and welcome. Please read our contributing guidelines containing detailed instructions on how to contribute correctly and create a proper pull request. If you have any questions, please feel free to reach out to us on our Discord server.

License

BSD 3-Clause License

Copyright (c) 2022, The Atsign Foundation

All rights reserved.

Maintainers

About

atPlatform implemented into the ESP32 microcontroller (Arduino C++)

License:BSD 3-Clause "New" or "Revised" License

Languages

Language:C++ 72.1%Language:C 27.9%