Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nateinaction committed Jan 7, 2025
1 parent d036d58 commit ef61095
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
![CI](https://github.com/texas-state-space-lab/pikvm-tailscale-certificate-renewer/actions/workflows/ci.yaml/badge.svg)

Software for CircuitPython flight software in the PROVES Kit. Currently this repo is reflecting PROVES Kit V1.5, where there is independent code for both the Flight Controller (FC) Board and Battery (Batt) Board. The file tree has been updated to reflect this. Please access either the **FC_Board (for Flight Controller software)** or **Batt_Board (For Battery Board Software)** as needed!
Software for CircuitPython flight software in the PROVES Kit.

If this is your first time using CircuitPython, it is highly recommended that you check out Adafruit's [Welcome to CircuitPython](https://learn.adafruit.com/welcome-to-circuitpython/overview?gad_source=1&gbraid=0AAAAADx9JvTRorSR2psQubn32WqebKusM&gclid=CjwKCAiA-Oi7BhA1EiwA2rIu28YArt-jNTE3W3uwE055Tp7hyH9c9pE_NsqIOOh1aopnW00qXGBedRoChysQAvD_BwE) to help you get started!

Expand Down Expand Up @@ -55,15 +55,9 @@ To run the precommit hook:

## General Structure:
- **boot.py** This is the code that runs on boot and initializes the stack limit
- **cdh.py** This is the code that handles all the commands. A majority of this code is pulled from the cdh file developed by Max Holliday at Stanford.
- **code.py** This code runs the main operating system of the satellite and handles errors on a high level allowing the system to be fault tolerant
- **detumble.py** This code implements the B-dot algorithm and returns outputs that allow the system to do a controlled detumble with the satellite's embedded magnetourquer coils
- **main.py** This code tasks all the functions the satellite should do in a semi-asynchronous manner utilizing the asyncio library
- **payload.py** This code implements any desired payload. On the Pleiades missions, the payload has been the BNO055 IMU. Since the use of a stemmaQT connector allows multiple devices on the same bus, a BNO IMU could be used in conjunction with several other sensors if desired.
- **safemode.py** This code is unimplemented pending new firmware releases that allow the microconrtoller to perform a routine when in safemode
## experimental
This software is completely experimental and is in development for helpful software related tasks.
- **sf_hop.py** This code is yet to be implemented in official flight software as it is desired to implement the ability to utilize several spreading factors to send different sized messages at different data rates
## lib
This software contains all of the libraries required to operate the sensors, pysquared board, and radio module.
- **asyncio** This is the library responsible for scheduling tasks in the main code
Expand All @@ -82,6 +76,9 @@ This software contains all of the libraries required to operate the sensors, pys
- **functions.py** This is a library of functions utilized by the satellite to obtain data, detumble, run the battery heater
- **pysquared.py** This is a library that initializes and maintains all the main functions for the pysquared architecture
- **pysquared_rfm9x.py** This is a library that implements all the radio hardware. This code is a modified version of the pycubed_rfm9x which is a modified version of the adafruit_rfm9x file.
- **cdh.py** This is the code that handles all the commands. A majority of this code is pulled from the cdh file developed by Max Holliday at Stanford.
- **detumble.py** This code implements the B-dot algorithm and returns outputs that allow the system to do a controlled detumble with the satellite's embedded magnetourquer coils

## tests
This software is used for performing tests on the satellite

Expand Down

0 comments on commit ef61095

Please sign in to comment.