Skip to content

Commit

Permalink
πŸ“ adds order form and fixes pages
Browse files Browse the repository at this point in the history
  • Loading branch information
acarrou committed Sep 29, 2023
1 parent eed9fd0 commit 385a618
Show file tree
Hide file tree
Showing 6 changed files with 62 additions and 14 deletions.
15 changes: 9 additions & 6 deletions docs/about/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,19 @@ Astraeus-I originated as a senior project at San Jose State University, collabor

During the course of its inception, our team had the opportunity to work closely with libhal, a collaborative effort that significantly contributed to the success and refinement of the project. This partnership was instrumental in navigating through the complexities and challenges that emerged during the development process, providing valuable insights and support that shaped Astraeus-I into its current form.

## Project Phases
## πŸ”„ Project Phases
Hardware Development Phase: The first semester of the project was devoted to the intricate process of hardware development. This phase entailed rigorous research, planning, and implementation to construct a robust hardware foundation for Astraeus-I, ensuring its reliability and efficiency in performing its designated functions.

## Software Development Phase
## πŸ”© Hardware Development Phase
The first semester of the project was devoted to the intricate process of hardware development. This phase entailed rigorous research, planning, and implementation to construct a robust hardware foundation for Astraeus-I, ensuring its reliability and efficiency in performing its designated functions.

## πŸ’» Software Development Phase
With a solid hardware base in place, the second semester was utilized for software development. This crucial phase involved coding, testing, and refining the software components to work seamlessly with the developed hardware, ultimately creating a cohesive and functional system.

## Collaborative Effort
## 🀝 Collaborative Effort
Engaging with libhal during the development process enriched our project with a wealth of knowledge and expertise in the field. Their consistent support and guidance played a pivotal role in overcoming technical hurdles and implementing best practices, resulting in a project outcome that not only met but exceeded our initial expectations.

## Team Members
## πŸ‘₯ Team Members
### Adrien Carrou
<div style="display: flex; align-items: center;">
<img src="../../assets/adrien.jpg" style="width: 100px; height: 100px; border-radius: 20%; margin-right: 20px;">
Expand All @@ -31,7 +34,7 @@ Engaging with libhal during the development process enriched our project with a
<p>Specialized in firmware development, Michell was instrumental in writing device and platform drivers, dedicating his efforts to perfecting the software components of the project.</p>
</div>

## Advisors
## πŸŽ“ Advisors

### Khalil Estell
<div style="display: flex; align-items: center;">
Expand All @@ -45,5 +48,5 @@ Engaging with libhal during the development process enriched our project with a
<p>As an advisor, Kaikai offered valuable insights and feedback that helped us navigate through the complexities of the project.</p>
</div>

## Acknowledgements
## πŸ™ Acknowledgements
We extend our gratitude to San Jose State University and libhal for their unwavering support and resources that were invaluable to the successful completion of Astraeus-I. Special thanks also go to our mentors, advisors, and everyone who contributed their time and expertise to bring this project to fruition. We would firstly like to thank our co-advisor **Khalil Estell** for the tremendous amount of support and guidance he provided throughout the project. We would also like to thank our advisor **Kaikai Liu** for his valuable insights and feedback that helped us navigate through the complexities of the project.
19 changes: 19 additions & 0 deletions docs/order_form/order_form.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# πŸ“‹ Order Form
Looking to acquire an Astraeus-I board? Explore the options listed below and complete the form to express your interest.
To ensure functionality, selecting a CPU is mandatory, while opting for an XBEE radio module is discretionary
(note: the board can operate without a radio module). Rest assured, the board will be equipped with all other essential sensors.


| Category | Item | Price |
|-------------------|----------------------------------------|------------|
| Board Price | Astraeus-I | **$70.00** |
| CPU Prices | [LPC4078](https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/lpc4000-arm-cortex-m4/32-bit-arm-cortex-m4-mcu-up-to-512-kb-flash-96-kb-sram-usb-device-host-otg-ethernet-emc-spifi:LPC4078FET180) **(recommended)** | **$25.00** |
| | [STM32F103RC](https://www.st.com/en/microcontrollers-microprocessors/stm32f103rc.html) (still being developed) | **$12.00** |
| XBEE Prices | [Lower end](https://www.digikey.com/en/products/detail/digi/XBRR-24Z8US/16916111) (up to 3200 meters or 2 miles)| **$38.25**|
| | [Middle end](https://www.digikey.com/en/products/detail/digi/XB9X-DMUS-001/5972742) (up to 14.5km or 9 miles) | **$48.07** |
| | [High end](https://www.digikey.com/en/products/detail/digi/XBP9X-DMUS-001/5972744?WT.z_cid=ref_neda_dkc_buynow_digiintl&utm_source=ecia&utm_medium=aggregator&utm_campaign=digiintl ) (up to 105km or 65 miles) | **$112.59**|

<a href="https://forms.gle/EEbP9Q2z8U36ZmDHA" target="_blank">πŸ“‹Asreaus-I Interest FormπŸ“‹</a>

!!! question
Have a question? Ask it on our [Discord](https://discord.gg/7H8FzkXEgZ) server!
4 changes: 4 additions & 0 deletions docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,8 @@ a:visited code {

.md-tabs {
background: linear-gradient(to right, #483D8B, #149fac); /* LightBlue to DarkSlateBlue */
}

.right-align {
margin-left: 500px !important;
}
4 changes: 4 additions & 0 deletions docs/stylesheets/extra.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
document.addEventListener("DOMContentLoaded", function() {
var navItem = [...document.querySelectorAll('.md-tabs__item')].find(item => item.textContent.includes('Order Form'));
if (navItem) navItem.classList.add('right-align');
});
30 changes: 22 additions & 8 deletions docs/user_guide/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,38 @@ The Astraeus-I board is built to be modular in hardware and software. It include

The boards software comprises of device drivers for each of the onboard devices, a telemetry recorder, and a board application package. The device drivers are used to interface with the onboard devices and are used by the telemetry recorder and board application package. The telemetry recorder is a tool used to record data from the onboard devices and either store it in the sd card or transmit the data if the board has a radio module installed. The board application package is used to run a custom application on the board. The application can be used to control the onboard devices and perform custom actions which you can use to build your own application.

## πŸ”Œ Wiring to other Devices
## βš™οΈ Hardware Details
🚧 Under construction 🚧

To wire the board to other devices, you can use the pinout diagram or the pin labels on the Astraeus-I board to find the pins you need to connect to. Then you will need to use the pinout diagram for the device you are connecting to and connect the pins to the corresponding pins on the device.

### πŸ“Œ Pinout Diagram

<img src="../../assets/Astraeus_Pinout.svg" style="height: 1200px;">
<img src="../../assets/Astraeus_Pinout.svg" style="height: 1200px; margin-bottom: -70px;">

## πŸ“ˆ Telemetry Recorder

### πŸ› οΈ Board Specifications
- **Dimensions**
- 52 mm x 85 mm
- Horizontal Mounting Hole Distance: 46.1 mm
- Vertical Mounting Hole Distance: 78.87 mm
- **Weight**
- 20.5 g
- **Power**
- Supply voltage: 5V
- Operating current: 200mA

## πŸ’» Software Details
🚧 Under construction 🚧

The telemetry recorder is a tool used to record data from the onboard devices and either store it in the sd card or transmit the data if the board has a radio module installed.
The boards software comprises of device drivers for each of the onboard devices, a telemetry recorder, and a board application package. The device drivers are used to interface with the onboard devices and are used by the telemetry recorder and board application package. The telemetry recorder is a tool used to record data from the onboard devices and either store it in the sd card or transmit the data if the board has a radio module installed. The board application package is used to run a custom application on the board. The application can be used to control the onboard devices and perform custom actions which you can use to build your own application.

## 🧩 Board Application Package
### πŸ“ˆ Telemetry Recorder
🚧 Under construction 🚧

The board application package is used to run a custom application on the board. The application can be used to control the onboard devices and perform custom actions which you can use to build your own application.
The telemetry recorder is a tool used to record data from the onboard devices and either store it in the sd card or transmit the data if the board has a radio module installed.

### 🧩 Board Application Package
🚧 Under construction 🚧

!!! question
Have a question? Ask it on our [Discord](https://discord.gg/7H8FzkXEgZ) server!
The board application package is used to run a custom application on the board. The application can be used to control the onboard devices and perform custom actions which you can use to build your own application.
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,16 @@ theme:
extra_css:
- stylesheets/extra.css

extra_javascript:
- 'stylesheets/extra.js'

nav:
- '🏑 Home': 'index.md'
- 'πŸš€ Getting Started': 'getting_started/getting_started.md'
- 'πŸ“– User Guide': 'user_guide/user_guide.md'
- 'πŸ“š API': 'api/api.md'
- 'πŸ“Š About': 'about/about.md'
- 'πŸ“‹ Order Form': 'order_form/order_form.md'

extra:
social:
Expand Down

0 comments on commit 385a618

Please sign in to comment.