Home - XilefTech/CharlieOSX GitHub Wiki

Welcome to the CharlieOSX wiki!

Introduction

What is CharlieOSX?

I would describe CharlieOSX as a kind of developing platform, based on Micropython and Pybricks. It is meant to be used on LEGO Mindstorms Ev3 Robots (support for more hubs might be comming in the future) to accurately control your robot, nomatter how it's built.

Why should I use CharlieOSX?

CharlieOSX will offer a Variety of different possibilities to control your robot. It has got methods for self-corrected driving based on a gyro sensor built-in and will drive as accurately as possible. You can also write "code" to drive the robot on the brick itself without the need of a laptop or something (currently WIP). CharlieOSX offers a user-friendly UI on the Brick-Display even with some little animations ;) Last but not least CharlieOSX is under constant development so if you got a problem, it will be fixed very soon!

Installation

  1. Download the project from this repo. Soon you'll be able to find the latest (somewhat) stable release here
  2. Open the Project in VSCode
  3. Go through the entire config.cfg and put in the parameters of your robot
  4. Everything should be now completely set up and ready to use. Just put your code in main.py

You can find more details about the Installation process here

Working with CharlieOSX

There are two main possibilities to use CharlieOSX:

1. Using CharlieOSX with its on-board user interface

In this mode, you're not writing any Code yourself and you will use the full potential of CharlieOSX just from the Brick-display! You will be able to program your robot to drive and do certain actions just by entering numbers on the brick, which you will be able to change on the fly, so there is no downtime, what soever for downloading or compiling code again to test your changes.

2. Only using the Driving Methods in your own code:

If you're using CharlieOS only for it's self-correcting and gyro-driven driving methods you won't get the UI on the display, but you will be able to write your own code in addition to the driving stuff.

More information on how to work with CharlieOSX can be found on the corresponding wiki page here