Skip to content

Commit

Permalink
✨ Updates Leika cover image
Browse files Browse the repository at this point in the history
  • Loading branch information
runeharlyk committed Nov 4, 2024
1 parent d587b42 commit 10b0aa3
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 38 deletions.
Binary file added images/leika.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
77 changes: 39 additions & 38 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,49 +1,49 @@
<div align="center">
<h1>
<br />
<a href="https://github.com/runeharlyk/SpotMicroESP32-Leika">
<img src="https://raw.githubusercontent.com/runeharlyk/SpotMicro-Leika/main/assets/logo.jpg" alt="Leika" width="350">
<img src="images/leika.jpg" alt="Leika" width="450">
</a>
<br>
<br />
Spot Micro - Leika 🐕
</h1>
<h4>A small quadruped robot, inspired by boston dynamic <a href="https://bostondynamics.com/products/spot/" target="_blank">Spot</a>.</h4>

<h4>A small quadruped robot, inspired by boston dynamic <a href="https://bostondynamics.com/products/spot/" target="_blank">Spot</a>.</h4>

<p>
<a href="#overview">Overview</a> •
<a href="#features">Key Features</a> •
<a href="#getting-started">Documentation</a> •
<a href="#credits">Credits</a> •
<a href="#license">License</a>
</p>
<p>
<a href="docs/readme.md"><strong>Explore the docs »</strong></a>
<!-- <br/> -->
<!-- <a href="#overview">Overview</a> •
<a href="#features">Key Features</a> •
<a href="#credits">Credits</a> •
<a href="#license">License</a> -->
</p>

[![Frontend Tests](https://github.com/runeharlyk/SpotMicroESP32-Leika/actions/workflows/frontend-tests.yml/badge.svg)](https://github.com/runeharlyk/SpotMicroESP32-Leika/actions/workflows/frontend-tests.yml)
[![PlatformIO CI](https://github.com/runeharlyk/SpotMicroESP32-Leika/actions/workflows/embedded-build.yml/badge.svg)](https://github.com/runeharlyk/SpotMicroESP32-Leika/actions/workflows/embedded-build.yml)

</div>
<!-- GIF ![screenshot](https://raw.githubusercontent.com/runeharlyk/SpotMicro-Leika/main/assets/logo.jpg) -->

## 📜 Overview
Leika is a smaller quadruped robot for the Spot-Micro community.
Built on an ESP32 and powered by FreeRTOS, she can handle multiple tasks seamlessly - Like video and data streaming, solving kinematic and gait planning, controlling IO and much more.
## 📜 Overview

Leika is a smaller quadruped robot for the Spot-Micro community.
Built on an ESP32 and powered by FreeRTOS, she can handle multiple tasks seamlessly - Like video and data streaming, solving kinematic and gait planning, controlling IO and much more.
By focusing on practicality and simplicity in both hardware and software, it offer an accessible platform for learning, experimentation, and modest real-world applications.

## 🎯 Features

* **Live Preview**: Instant feedback with real-time updates.
* **Real-Time Data**: Stream camera feeds, monitor sensors, and analyze data on the fly.
* **Kinematic Precision**: Full kinematic model for accurate movements.
* **Dual joystick controller**
* **Robot mirroring visualization**
* **Highly customizable**
* **Self-Hosted**: Complete autonomy, from code to execution.
- **Live Preview**: Instant feedback with real-time updates.
- **Real-Time Data**: Stream camera feeds, monitor sensors, and analyze data on the fly.
- **Kinematic Precision**: Full kinematic model for accurate movements.
- **Dual joystick controller**
- **Robot mirroring visualization**
- **Highly customizable**
- **Self-Hosted**: Complete autonomy, from code to execution.
<!-- * Servo calibration tool -->

### 🎮 Controller

<img src="images/controller.gif" alt="controller" width="500">

### 🛠️ Documentation
### 🛠️ Documentation

You can find the current steps to get a fresh new doggo up and barking on [/docs](docs/readme.md)

Expand All @@ -61,36 +61,37 @@ You can find a description for the current esp32 firmware and controller [here](

<!--## 🧠 Kinematics
The kinematic for the robot is from this [kinematics paper](https://www.researchgate.net/publication/320307716_Inverse_Kinematic_Analysis_Of_A_Quadruped_Robot). A C++ and TypeScript library was written to enable onboard calculation and fast development iteration using the robot mirroring.
The kinematic for the robot is from this [kinematics paper](https://www.researchgate.net/publication/320307716_Inverse_Kinematic_Analysis_Of_A_Quadruped_Robot). A C++ and TypeScript library was written to enable onboard calculation and fast development iteration using the robot mirroring.
-->

## 🔮 Getting started

1. Clone and open the new project

```sh
git clone https://github.com/runeharlyk/SpotMicroESP32-Leika
```
```sh
git clone https://github.com/runeharlyk/SpotMicroESP32-Leika
```

1. Install dependencies with preferable package manager (npm, pnpm, yarn)

```sh
cd app
pnpm install
```
```sh
cd app
pnpm install
```

1. Configure device settings
1. Update `factory_settings.ini` with relevant settings

1. Update `factory_settings.ini` with relevant settings

1. Upload filesystem image using platformIO

1. Upload firmware using platformIO

## 🚀 Future
## 🚀 Future

See the [project backlog](https://github.com/users/runeharlyk/projects/3) and [open issues](https://github.com/runeharlyk/SpotMicroESP32-Leika/issues) for full list of proposed and active features (and known issues).

## 🙌 Credits
## 🙌 Credits

This project takes great inspiration from the following resources:

Expand All @@ -102,16 +103,16 @@ This project takes great inspiration from the following resources:
1. [Spot Micro - Leika](https://github.com/runeharlyk/SpotMicro-Leika/tree/main)
1. [NightDriverStrip](https://github.com/PlummersSoftwareLLC/NightDriverStrip)

## ☕ Support
## ☕ Support

If you like the project and want to follow it evolving concidering ✨-ing the project

<a href="https://bmc.link/runeharlyk" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/purple_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>

## You may also like...

* [Spot Micro Quadruped Project - mike4192](https://github.com/mike4192/spotMicro) - Great ROS based project
* [SpotMicroAi](https://gitlab.com/public-open-source/spotmicroai) - Group repository with simulations and runtimes
- [Spot Micro Quadruped Project - mike4192](https://github.com/mike4192/spotMicro) - Great ROS based project
- [SpotMicroAi](https://gitlab.com/public-open-source/spotmicroai) - Group repository with simulations and runtimes

## 📃 License

Expand Down

0 comments on commit 10b0aa3

Please sign in to comment.