Skip to content

Commit 71a5ba0

Browse files
bytecod3bytecod3
committed
UPDATES docs
1 parent 8e757db commit 71a5ba0

File tree

2 files changed

+150
-86
lines changed

2 files changed

+150
-86
lines changed

‎Doxyfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ PROJECT_BRIEF = 1U Cubesat Documentation
6161
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
6262
# the logo to the output directory.
6363

64-
PROJECT_LOGO = logo-3.png
64+
PROJECT_LOGO = ./image-assets/logo-3.png
6565

6666
# With the PROJECT_ICON tag one can specify an icon that is included in the tabs
6767
# when the HTML document is shown. Doxygen will copy the logo to the output

‎README.md‎

Lines changed: 149 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -2,89 +2,153 @@
22
<strong>🚧 In Development:</strong> This CubeSat project and its documentation are actively being developed. Expect frequent updates and changes.
33
</div>
44

5-
## Table of Contents
6-
7-
- [Project-Shadow-Flight](#project-shadow-flight)
8-
- [Introduction](#introduction)
9-
- [Web documentation](#web-documentation)
10-
- [Design Videos for visual consumers](#design-videos-for-visual-consumers)
11-
- [Motivation](#motivation)
12-
- [Mission statement](#mission-statement)
13-
- [System components](#system-components)
14-
- [1. Onboard Computer](#1-onboard-computer)
15-
- [Introduction](#introduction-1)
16-
- [Functional requirements](#functional-requirements)
17-
- [Components of the OBC](#components-of-the-obc)
18-
- [2. Sensor Board](#2-sensor-board)
19-
- [Introduction](#introduction-2)
20-
- [Functional requirements](#functional-requirements-1)
21-
- [Communication protocol for sensors](#communication-protocol-for-sensors)
22-
- [The PC/104 ISA Bus](#the-pc104-isa-bus)
23-
- [My Pin definition](#my-pin-definition)
24-
- [3. Attitude Determination and Control](#3-attitude-determination-and-control)
25-
- [4. Electrical Power System (EPS)](#4-electrical-power-system-eps)
26-
- [Introduction](#introduction-3)
27-
- [a) Power consumption of different bus components](#a-power-consumption-of-different-bus-components)
28-
- [b) Power generation](#b-power-generation)
29-
- [c) Energy storage](#c-energy-storage)
30-
- [d) Mission analysis in regards to power](#d-mission-analysis-in-regards-to-power)
31-
- [e) EPS Schematics summary](#e-eps-schematics-summary)
32-
- [Conversion](#conversion)
33-
- [Power Distribution Schemes](#power-distribution-schemes)
34-
- [Power supply control](#power-supply-control)
35-
- [f) Isolated tests](#f-isolated-tests)
36-
- [g) EPS integration and Testing](#g-eps-integration-and-testing)
37-
- [Battery and solar panel sizing data](#battery-and-solar-panel-sizing-data)
38-
- [5. Payload and Mission Design](#5-payload-and-mission-design)
39-
- [Payload system requirements](#payload-system-requirements)
40-
- [Payload communication interface](#payload-communication-interface)
41-
- [Payload PCB](#payload-pcb)
42-
- [Tracks](#tracks)
43-
- [3D view](#3d-view)
44-
- [Communication Protocol](#communication-protocol)
45-
- [CCSDS Telemetry(TM) Space Data Link Protocol](#ccsds-telemetrytm-space-data-link-protocol)
46-
- [What is CCSDS Space Data Link Protocol](#what-is-ccsds-space-data-link-protocol)
47-
- [CCSDS protocol data unit (PDU)](#ccsds-protocol-data-unit-pdu)
48-
- [Field descriptions](#field-descriptions)
49-
- [How it is implemented](#how-it-is-implemented)
50-
- [Protocol data frame (PDU)](#protocol-data-frame-pdu)
51-
- [1. Primary header](#1-primary-header)
52-
- [Transfer Frame Version Number](#transfer-frame-version-number)
53-
- [Spacecraft Identifier (SCID)](#spacecraft-identifier-scid)
54-
- [CCSDS Transfer Frame Header – Virtual Channel, Control Flag, and Counters](#ccsds-transfer-frame-header--virtual-channel-control-flag-and-counters)
55-
- [Virtual Channel Identifier (VCID)](#virtual-channel-identifier-vcid)
56-
- [Operational Control Field Flag (OCF Flag)](#operational-control-field-flag-ocf-flag)
57-
- [Master Channel Frame Count (MCFC)](#master-channel-frame-count-mcfc)
58-
- [Virtual Channel Frame Count (VCFC)](#virtual-channel-frame-count-vcfc)
59-
- [Transfer Frame Data Field Status (TFDFS)](#transfer-frame-data-field-status-tfdfs)
60-
- [Purpose](#purpose)
61-
- [CCSDS Transfer Frame Secondary Header](#ccsds-transfer-frame-secondary-header)
62-
- [Overview](#overview)
63-
- [Structure](#structure)
64-
- [Channel Association](#channel-association)
65-
- [Usage Rules](#usage-rules)
66-
- [Secondary header data field usage](#secondary-header-data-field-usage)
67-
- [Transfer Frame Data Field](#transfer-frame-data-field)
68-
- [Overview](#overview-1)
69-
- [Field Length](#field-length)
70-
- [Field Contents](#field-contents)
71-
- [Channel Data Rules](#channel-data-rules)
72-
- [Packet Placement](#packet-placement)
73-
- [OID (Only Idle Data) Transfer Frames](#oid-only-idle-data-transfer-frames)
74-
- [OID Frame Rules](#oid-frame-rules)
75-
- [LFSR Initialization](#lfsr-initialization)
76-
- [VCID Association](#vcid-association)
77-
- [Notes](#notes)
78-
- [Idle data](#idle-data)
79-
- [Frame Error Control Field (FECF)](#frame-error-control-field-fecf)
80-
- [Overview](#overview-2)
81-
- [Encoding Procedure](#encoding-procedure)
82-
- [Interface with the ground station](#interface-with-the-ground-station)
83-
- [Data limits and known issues](#data-limits-and-known-issues)
84-
- [Related documents](#related-documents)
85-
- [Relevant videos and resource materials](#relevant-videos-and-resource-materials)
86-
- [Contribution and support](#contribution-and-support)
87-
- [Contributors](#contributors)
5+
6+
<details open>
7+
<summary><h2> Table of Contents</h2></summary>
8+
9+
<ul>
10+
<li><a href="#project-shadow-flight">Project-Shadow-Flight</a>
11+
<ul>
12+
<li><a href="#introduction">Introduction</a>
13+
<ul>
14+
<li><a href="#web-documentation">Web documentation</a></li>
15+
<li><a href="#design-videos-for-visual-consumers">Design Videos for visual consumers</a></li>
16+
</ul>
17+
</li>
18+
<li><a href="#motivation">Motivation</a></li>
19+
<li><a href="#mission-statement">Mission statement</a></li>
20+
</ul>
21+
</li>
22+
<li><a href="#system-components">System components</a>
23+
<ul>
24+
<li><a href="#1-onboard-computer">1. Onboard Computer</a>
25+
<ul>
26+
<li><a href="#introduction-1">Introduction</a></li>
27+
<li><a href="#functional-requirements">Functional requirements</a></li>
28+
<li><a href="#components-of-the-obc">Components of the OBC</a></li>
29+
</ul>
30+
</li>
31+
<li><a href="#2-sensor-board">2. Sensor Board</a>
32+
<ul>
33+
<li><a href="#introduction-2">Introduction</a></li>
34+
<li><a href="#functional-requirements-1">Functional requirements</a></li>
35+
<li><a href="#communication-protocol-for-sensors">Communication protocol for sensors</a></li>
36+
<li><a href="#the-pc104-isa-bus">The PC/104 ISA Bus</a></li>
37+
<li><a href="#my-pin-definition">My Pin definition</a></li>
38+
</ul>
39+
</li>
40+
<li><a href="#3-attitude-determination-and-control">3. Attitude Determination and Control</a></li>
41+
<li><a href="#4-electrical-power-system-eps">4. Electrical Power System (EPS)</a>
42+
<ul>
43+
<li><a href="#introduction-3">Introduction</a></li>
44+
<li><a href="#a-power-consumption-of-different-bus-components">a) Power consumption of different bus components</a></li>
45+
<li><a href="#b-power-generation">b) Power generation</a></li>
46+
<li><a href="#c-energy-storage">c) Energy storage</a></li>
47+
<li><a href="#d-mission-analysis-in-regards-to-power">d) Mission analysis in regards to power</a></li>
48+
<li><a href="#e-eps-schematics-summary">e) EPS Schematics summary</a>
49+
<ul>
50+
<li><a href="#conversion">Conversion</a></li>
51+
<li><a href="#power-distribution-schemes">Power Distribution Schemes</a></li>
52+
<li><a href="#power-supply-control">Power supply control</a></li>
53+
</ul>
54+
</li>
55+
<li><a href="#f-isolated-tests">f) Isolated tests</a></li>
56+
<li><a href="#g-eps-integration-and-testing">g) EPS integration and Testing</a>
57+
<ul>
58+
<li><a href="#battery-and-solar-panel-sizing-data">Battery and solar panel sizing data</a></li>
59+
</ul>
60+
</li>
61+
</ul>
62+
</li>
63+
</ul>
64+
</li>
65+
<li><a href="#5-payload-and-mission-design">5. Payload and Mission Design</a>
66+
<ul>
67+
<li><a href="#payload-system-requirements">Payload system requirements</a></li>
68+
<li><a href="#payload-communication-interface">Payload communication interface</a></li>
69+
<li><a href="#payload-pcb">Payload PCB</a>
70+
<ul>
71+
<li><a href="#tracks">Tracks</a></li>
72+
<li><a href="#3d-view">3D view</a></li>
73+
</ul>
74+
</li>
75+
</ul>
76+
</li>
77+
<li><a href="#communication-protocol">Communication Protocol</a>
78+
<ul>
79+
<li><a href="#ccsds-telemetrytm-space-data-link-protocol">CCSDS Telemetry(TM) Space Data Link Protocol</a>
80+
<ul>
81+
<li><a href="#what-is-ccsds-space-data-link-protocol">What is CCSDS Space Data Link Protocol</a></li>
82+
<li><a href="#ccsds-protocol-data-unit-pdu">CCSDS protocol data unit (PDU)</a></li>
83+
<li><a href="#field-descriptions">Field descriptions</a></li>
84+
<li><a href="#how-it-is-implemented">How it is implemented</a></li>
85+
<li><a href="#protocol-data-frame-pdu">Protocol data frame (PDU)</a>
86+
<ul>
87+
<li><a href="#1-primary-header">1. Primary header</a>
88+
<ul>
89+
<li><a href="#transfer-frame-version-number">Transfer Frame Version Number</a></li>
90+
<li><a href="#spacecraft-identifier-scid">Spacecraft Identifier (SCID)</a></li>
91+
</ul>
92+
</li>
93+
<li><a href="#ccsds-transfer-frame-header--virtual-channel-control-flag-and-counters">
94+
CCSDS Transfer Frame Header – Virtual Channel, Control Flag, and Counters
95+
</a>
96+
<ul>
97+
<li><a href="#virtual-channel-identifier-vcid">Virtual Channel Identifier (VCID)</a></li>
98+
<li><a href="#operational-control-field-flag-ocf-flag">Operational Control Field Flag (OCF Flag)</a></li>
99+
<li><a href="#master-channel-frame-count-mcfc">Master Channel Frame Count (MCFC)</a></li>
100+
<li><a href="#virtual-channel-frame-count-vcfc">Virtual Channel Frame Count (VCFC)</a></li>
101+
<li><a href="#transfer-frame-data-field-status-tfdfs">Transfer Frame Data Field Status (TFDFS)</a></li>
102+
<li><a href="#purpose">Purpose</a></li>
103+
</ul>
104+
</li>
105+
<li><a href="#ccsds-transfer-frame-secondary-header">CCSDS Transfer Frame Secondary Header</a>
106+
<ul>
107+
<li><a href="#overview">Overview</a></li>
108+
<li><a href="#structure">Structure</a></li>
109+
<li><a href="#channel-association">Channel Association</a></li>
110+
<li><a href="#usage-rules">Usage Rules</a></li>
111+
<li><a href="#secondary-header-data-field-usage">Secondary header data field usage</a></li>
112+
</ul>
113+
</li>
114+
<li><a href="#transfer-frame-data-field">Transfer Frame Data Field</a>
115+
<ul>
116+
<li><a href="#overview-1">Overview</a></li>
117+
<li><a href="#field-length">Field Length</a></li>
118+
<li><a href="#field-contents">Field Contents</a></li>
119+
<li><a href="#channel-data-rules">Channel Data Rules</a></li>
120+
<li><a href="#packet-placement">Packet Placement</a></li>
121+
</ul>
122+
</li>
123+
<li><a href="#oid-only-idle-data-transfer-frames">OID (Only Idle Data) Transfer Frames</a>
124+
<ul>
125+
<li><a href="#oid-frame-rules">OID Frame Rules</a></li>
126+
<li><a href="#lfsr-initialization">LFSR Initialization</a></li>
127+
<li><a href="#vcid-association">VCID Association</a></li>
128+
<li><a href="#notes">Notes</a></li>
129+
<li><a href="#idle-data">Idle data</a></li>
130+
</ul>
131+
</li>
132+
<li><a href="#frame-error-control-field-fecf">Frame Error Control Field (FECF)</a>
133+
<ul>
134+
<li><a href="#overview-2">Overview</a></li>
135+
<li><a href="#encoding-procedure">Encoding Procedure</a></li>
136+
</ul>
137+
</li>
138+
</ul>
139+
</li>
140+
<li><a href="#interface-with-the-ground-station">Interface with the ground station</a></li>
141+
<li><a href="#data-limits-and-known-issues">Data limits and known issues</a></li>
142+
</ul>
143+
</li>
144+
</ul>
145+
</li>
146+
<li><a href="#related-documents">Related documents</a></li>
147+
<li><a href="#relevant-videos-and-resource-materials">Relevant videos and resource materials</a></li>
148+
<li><a href="#contribution-and-support">Contribution and support</a></li>
149+
<li><a href="#contributors">Contributors</a></li>
150+
</ul>
151+
</details>
88152

89153

90154
# Project-Shadow-Flight
@@ -724,5 +788,5 @@ about the project details,
724788

725789
## Contributors
726790
1. Edwin Mwiti
727-
2. Augustine Gyan
728-
3. Sebastian Muchui
791+
2. Augustine Gyan [](https://github.com/augustinegyan)
792+
3. Sebastian Muchui [](https://github.com/astianmuchui)

0 commit comments

Comments
 (0)