-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated README.md and made main.py executable
- Loading branch information
Showing
2 changed files
with
12 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,26 @@ | ||
# pfs | ||
|
||
## TODO | ||
- [ ] Before deployment: make it so that critical parameters can't be changed in-flight | ||
- [x] Update clock from GPS once/minute | ||
- [ ] Implement bursted telemetry | ||
- [x] Implement commands | ||
- [x] Implement telemetry | ||
- [x] Implement deferred function running | ||
- [x] Implement automatic process restarting | ||
- [x] Make Iridium stable and usable | ||
- [ ] Sanity checks | ||
- [ ] **Documentation** - almost done | ||
- [ ] EPS watchdog petting | ||
- [ ] Initial deployment (submodule?) | ||
|
||
# pFS | ||
## Python Flight Software | ||
|
||
## Development | ||
|
||
Use `pipenv` to manage the development environment. | ||
1. Clone this repo | ||
2. Use `pipenv` to manage the development environment. | ||
More information on `pipenv` available in the [documentation](https://pipenv.readthedocs.io/en/latest/). | ||
If you already have `pipenv` installed, run: | ||
``` | ||
pipenv install # Install dependencies | ||
``` | ||
Alternatively, configure your IDE to use the pipenv as the Python interpreter. | ||
|
||
## Usage | ||
* Alternatively, configure your IDE to use the pipenv as the Python interpreter. | ||
3. Activate the `pipenv shell` | ||
4. Run `python3 main.py` | ||
|
||
## Dependencies | ||
- `Python 3.6` or greater is required along with `pip` | ||
### Usage | ||
`invoke` is used as the task runner. | ||
Ensure that you install `invoke` globally (not in your virtual environment) using `pip3 install invoke`. | ||
Below are the available commands: | ||
|
||
- `invoke run`: Run the flight software. | ||
- `invoke run -d`: Debug mode. | ||
- `invoke run -p`: Production mode, use this when running on a staging or production environment. | ||
- `invoke deploy`: Install all required packages _globally_. Only run this on a staging or production environment. | ||
|
||
|
||
## Dependencies | ||
* `smbus`/`smbus2` are not compatible with Windows `cmd.exe`, either: | ||
* Use Linux/WSL to install and run | ||
* Run remotely on `pi-cubesat` with `ssh` | ||
- `invoke deploy`: Install all required packages _globally_. Only run this on a staging or production environment. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
#!/usr/bin/env python3 | ||
import logging | ||
import sys | ||
|
||
|