Code Monkey home page Code Monkey logo

espri's Introduction

ESPRI

ESPRI (ESP Radio Interface) project providing extended functionalities to ham radios.

V1 board connected to UV-K5 radio:

espri

V2 board:

High level diagram:

high-level-diagram-4

The main goal of this project is to extend functionalities of ham radios with addition of a small PCB board that contains ESP32 microcontroller.

As such following features would be enabled:

  • custom digital modes (modulated and demodulated by the ESP chip)
    • more advanced messaging
      • could be served as webpage by the esp chip itself
      • or have a mobile client as Meshtastic
  • wireless UART connection to the radio
  • record .wav files
  • broadcast .wav files
  • turning any radio into IoT device via JSON API served from the ESP
  • turning radios into wireless modems

The physicial inteface layer between the ESPRI and the host radio will be through the Kenwood connector.

Table of Contents

Web panel

Here is a screenshot of a web control panel being served from the ESP:

espri-new-ui

settings-general

Morse code beacon config:

morse

Notifications (real-time communication via Websocket):

notifications

System info:

system_info

ESP Log:

I (8732) WEB/API/EVENT_HANDLER: Event id:3 received
I (8732) WEB/API/EVENT_HANDLER: Sent: SMS: API event: 3 received.

Hardware

ESP32 board

ESP32 Lolin Lite (recommended, confirmed to work, lipo charger built-in):

esp32-lolin-lite

ESPRI hat

In order to interface radios through Kenwood connector following analog components have to be added to the ESP board:

schematic

Reference https://github.com/ludwich66/Quansheng_UV-K5_Wiki/wiki/Programming-Cable for Kenwood pinout.

Custom PCB:

V1.0:

V2.2:

This firmware uses:

  • Espressif IoT Development Framework (ESP-IDF) v5.2.1

Getting started

Tip

You can flash this firmware with esptool.py or with ESP-Launchpad (using web browser)

To flash with esptool.py:

esptool.py write_flash 0x0 espri.bin

Once flashed:

  • Connect to WIFI access point NOKIA-3K9N4H1 with password mypassword
  • Go to http://192.168.4.1

Manual

Please take a look at the Wiki section for instructions, tips and more.

Development

With Visual Studio Code and ESP-IDF extension (recommended)

This method will install ESP-IDF toolchain locally with the help of the ESP-IDF Visual Studio Code extension.

PROS:

  • IntelliSense in Visual Studio Code will work and errors are linted live during development
  • Flashing, building, monitoring can be done directly from the Visual Studio Code

CONS:

  • It will install toolchain locally

STEPS:

  1. Install Visual Studio Code.
  2. Install ESP-IDF Visual Studio extension.
  3. Perform EXPRESS configuration and select correct ESP-IDF version

With Docker

This method will perform build within the Docker container.

PROS:

  • Clean install.

CONS:

  • IntelliSense in Visual Studio Code will not work (due to weird ESP-IDF structure and dynamic file inclusion)

STEPS:

  1. Download ESP-IDF library:
git clone --recursive https://github.com/espressif/esp-idf.git
  1. Remove examples folder:
rm -rf esp-idf/examples
  1. Remove .git folder:
rm -rf esp-idf/.git
  1. Update VS Code include PATH (file c_cpp_properties.json):
 "includePath": [
                "${workspaceFolder}/**",
                "${workspaceFolder}/esp-idf/components/**"
            ],
  1. Install esptool:
pip3 install --user esptool
  1. Build:
make docker
  1. Flash:
make flash

How to contribute

Thank you for your interest in contributing to this project! Here are some of the many ways in which you can help:

  • Report bugs
  • Suggest improvements
  • Audit the source code
  • Submit PRs to fix bugs or implement features
  • Test new releases and updates
  • Record videos and post on other platforms
  • Spread the word about this project
  • Write and edit the documentation

References

License

Copyright 2024 kamilsss655 https://github.com/kamilsss655

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

espri's People

Contributors

kamilsss655 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.