https://github.com/raresail/pico-w-template

This is a TCP Socket Server template for the RPI Pico W with features like AES 256 CTR encryption, JSON, Ping System
https://github.com/raresail/pico-w-template

aes-256 aes-ctr c cpp json pico-wireless rasspberry-pi socket tcp-server template

Last synced: 3 months ago
JSON representation

This is a TCP Socket Server template for the RPI Pico W with features like AES 256 CTR encryption, JSON, Ping System

• Host: GitHub
• URL: https://github.com/raresail/pico-w-template
• Owner: RaresAil
• License: apache-2.0
• Created: 2022-08-22T18:02:26.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-02-04T14:32:46.000Z (almost 2 years ago)
• Last Synced: 2024-10-04T16:41:44.471Z (4 months ago)
• Topics: aes-256, aes-ctr, c, cpp, json, pico-wireless, rasspberry-pi, socket, tcp-server, template
• Language: C++
• Homepage:
• Size: 199 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Examples

This template includes example code for the following services

> ### **WARNING, be careful on how you do your wiring or you might damage something**

- Adjustable Desk with a 4 pin connector

- Thermostat for a central heating unit

## General

The current features of this template. For the defaults of the features check the `Config` section

- Auto close connection if client didn't sent any request in a specific amount of time

- Set a specific number of simultaneous clients.

- Max packet size in bytes.

- Set TCP port.

- Set the Wifi SSID and Password at compile time

- JSON format for packet's data

- AES 256 CTR encryption

- PING system

- RTC

- Method to send a message to all connected clients

- Flash UID read at boot and stored in variable `FLASH_SERIAL_NUMBER` as `HEX`

The `server.cpp` could stay untouched, for parsing the data you can just check `handler.cpp`, after the request is processed the data is sent to the handler along with the client from which you can respond back.

You can keep the connection alive in order to have real time responses

## Packets

The packet format is `number_of_characters;data` e.g. `4;demo`

## Config file

- Path: `src/config.h`

- Code:

  ```h

  #ifndef __CONFIG_H__

  #define __CONFIG_H__

  #include "pico/cyw43_arch.h"

  #define COUNTRY_CODE_0                  'U'

  #define COUNTRY_CODE_1                  'S'

  #define WIFI_AUTH                       CYW43_AUTH_WPA2_AES_PSK

  #define WIFI_PASSWORD                   "PASSWORD"

  #define FIRMWARE_VERSION                "0.1.0" // Your version

  #define WIFI_SSID                       "SSID"

  /**

  * 1 - Thermostat

  * 2 - Desk

  */

  #define SERVICE_TYPE                    2

  // TCP SERVER

  #define TCP_SERVER_PORT                 8098

  #define TCP_SERVER_BUF_SIZE             2048

  #define TCP_SERVER_POLL_TIME_S          5

  #define TCP_SERVER_MAX_CLIENTS          5

  #define TCP_SERVER_INACTIVE_TIME_S      35

  // ENCRYPTION

  // To disable encryption do not define this variable

  #define AES_ENCRYPTION_KEY              "32-BYTES-KEY-IN-BASE64"

  #endif

  ```