diff --git a/readme.md b/readme.md index e2b2548..97f3fd6 100644 --- a/readme.md +++ b/readme.md @@ -9,15 +9,6 @@

A small quadruped robot, inspired by boston dynamic Spot.

- -

Key Features • Overview • @@ -36,22 +27,20 @@ [![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) -[![Embedded app build size](https://github.com/runeharlyk/SpotMicroESP32-Leika/actions/workflows/build-restriction.yml/badge.svg)](https://github.com/runeharlyk/SpotMicroESP32-Leika/actions/workflows/build-restriction.yml) ## Key Features * Live preview - Make changes, See changes - * Real time data sync - - + * Camera live stream * Dual joystick controller * Dark/Light mode - * Full screen mode * Immersive, distraction free. * Self hosted, self included + + ## Overview @@ -139,18 +128,13 @@ To dis-/enable the major feature I use defines. Define them in either featurefla | FT_SECURITY | Whether or not to use login system | 0 | FT_MQTT | Whether or not to use MQTT | 0 | FT_SLEEP | Whether or not include sleep management | 0 -| FT_UPLOAD_FIRMWARE | Whether or not to use OAT | 1 -| FT_DOWNLOAD_FIRMWARE | Whether or not to use github for firmware updates | 1 +| FT_UPLOAD_FIRMWARE | Whether or not to use OAT | 0 +| FT_DOWNLOAD_FIRMWARE | Whether or not to use github for firmware updates | 0 | FT_ANALYTICS | Whether or not to use analytics service | 1 -| TF_MDNS | Whether or not to use MDNS | 1 -| TF_DNS_SERVER | Whether or not to use DNS server | 1 -| TF_MPU | Whether or not to use MPU | 1 -| TF_POWER_BUTTON | Whether or not to use power button | 1 -| TF_USS | Whether or not to use ultra sonic sensors | 1 -### 📲Web application +### 📲 Controller -The web application is a simple Svelte app, which main focus is to calibrate and control the robot. +The controller is a SvelteKit app, which main focus is to calibrate and control the robot. It is made to be included and hosted by the robot. Therefore there is placed a lot of thought behind the functionality and dependencies. @@ -165,8 +149,6 @@ For the development dependencies I choose the following | Vite | Vite is a frontend tool that is used for building fast and optimized web applications. Is serves code local during development and bundles assets for production | Typescript | TypeScript's integration of static typing enhances code reliability and maintainability. | Tailwind CSS | Tailwind CSS accelerates web development with its utility-first approach, ensuring rapid styling and consistent design. - -| Vite compression plugin | This plugin compresses the *index.html* file making the final footprint a lot smaller. #### Libraries @@ -181,26 +163,6 @@ For the app functionality I choose the following: | [Uzip](https://www.npmjs.com/package/uzip) | Simple, tiny and fast ZIP library. | [ChartJS](https://www.npmjs.com/package/chart.js) | Simple and flexible charting library. - - ## Kinematics The kinematic for the robot is from this [kinematics paper](https://www.researchgate.net/publication/320307716_Inverse_Kinematic_Analysis_Of_A_Quadruped_Robot) @@ -213,7 +175,7 @@ The kinematic for the robot is from this [kinematics paper](https://www.research git clone https://github.com/runeharlyk/SpotMicroESP32-Leika ``` -1. Install dependencies +1. Install dependencies with preferable package manager (npm, pnpm, yarn) ```sh cd app @@ -223,6 +185,10 @@ The kinematic for the robot is from this [kinematics paper](https://www.research 1. Configure device settings 1. Update `factory_settings.ini` with relevant settings +1. Upload filesystem image using platformIO + +1. Upload firmware using platformIO + ## Usage ### Developing @@ -230,25 +196,14 @@ The kinematic for the robot is from this [kinematics paper](https://www.research 1. Run the app ```sh + cd app pnpm run dev ``` -### Building - -1. Build the app - - ```sh - pnpm run build - ``` - -1. Upload Filesystem Image using platformIO - ## Future See the [open issues](https://github.com/runeharlyk/SpotMicroESP32-Leika/issues) for a full list of proposed features (and known issues). - - ## Credits This project takes great inspiration from the following resources: