Skip to content

Commit 7bd2314

Browse files
Revise CameraHandler documentation
Updated documentation for the CameraHandler component, including usage examples, port descriptions, commands, and requirements.
1 parent ef8f283 commit 7bd2314

File tree

1 file changed

+16
-26
lines changed
  • FprimeZephyrReference/Components/CameraHandler/docs

1 file changed

+16
-26
lines changed
Lines changed: 16 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,30 @@
11
# Components::CameraHandler
22

3-
passive component that handles camera specific payload capabilities
3+
Passive component that handles camera specific payload capabilities.
4+
- Taking Images
5+
- Pinging
46

57
## Usage Examples
6-
Add usage examples here
7-
8-
### Diagrams
9-
Add diagrams here
8+
The camera handler can be commanded to take an image, after which it will forward a command to the PayloadCom component. It will then read in data from the PayloadCom until the image has finished sending.
109

1110
### Typical Usage
12-
And the typical usage of the component here
13-
14-
## Class Diagram
15-
Add a class diagram here
11+
Prior to taking a picture, the payload power loadswitch must be activated. Then "PING" the camera with the ping command. If the PING command returns successfully, then the camera is ready to take an image.
1612

1713
## Port Descriptions
1814
| Name | Description |
19-
|---|---|
20-
|---|---|
15+
|commandOut|Command to forward to the PayloadCom component|
16+
|dataIn|Data received from the PayloadCom component|
2117

2218
## Component States
2319
Add component states in the chart below
2420
| Name | Description |
25-
|---|---|
26-
|---|---|
27-
28-
## Sequence Diagrams
29-
Add sequence diagrams here
30-
31-
## Parameters
32-
| Name | Description |
33-
|---|---|
34-
|---|---|
21+
|m_receiving|True when the camera is currently receiving image data|
3522

3623
## Commands
3724
| Name | Description |
38-
|---|---|
39-
|---|---|
25+
|PING|Send a ping to the camera - wait for a response|
26+
|TAKE_IMAGE|Send "snap" command to the payload com component|
27+
|SEND_COMMAND|Send a user-specified command to the payload com component|
4028

4129
## Events
4230
| Name | Description |
@@ -57,10 +45,12 @@ Add unit test descriptions in the chart below
5745
## Requirements
5846
Add requirements in the chart below
5947
| Name | Description | Validation |
60-
|---|---|---|
61-
|---|---|---|
48+
|CameraHandler-001|The CameraHandler has a command to take an image. |Manual Test|
49+
|CameraHandler-002|The CameraHandler has a command to "ping" the camera. |Manual Test|
50+
|CameraHandler-003|The Camera Handler forwards the commands to the PayloadCom Component.|Manual Test|
51+
|CameraHandler-004|The Camera Handler receives all image data bytes and saves them to a new file.|Manual Test|
6252

6353
## Change Log
6454
| Date | Description |
6555
|---|---|
66-
|---| Initial Draft |
56+
|---| Initial Draft |

0 commit comments

Comments
 (0)