Computer Vision Knowledge Base Documentation Outline

1. Add a subpage to CV knowledge base

→ page should be titled as the module name e.g targetAquisition

2. Write an overview of the modules' purpose (plz)

3. Include architecture diagrams so that people who’ve never seen the module understand how it fits in within the pipeline

→ e.g

Alternatively, if want to address a single method or class can format as such:

USBInterface/UARTInterface

USBInterface/UARTInterface

-endpoints: Dictionary {endpointId: endpoint object (Serial object or Endpoint object)}. The first one is populated by calling the create_endpoint_FC() function in the constructor.

+read(endpointId): Issues a read command in either serial (UART) or pyusb (USB). EndpointId can be the specific serial port to use or the usb endpoint to be used.

+write(endpointId, data): Issues a write command in either serial or pyusb. Data parameter should be a buffer.

+create_endpoint_FC(): Returns a new endpoint, either a Serial object (UART) or Endpoint object (USB), that points to our flightcontroller.

4. Address the concepts needed to understand what the module does

→ e.g for geolocation, what equations are used? what are they used for? feel free to also give examples in code snippets to aid in comprehension

e.g

// QR_COORDINATES and TARGET_COORDINATES
{
  lattitude: double,
  longtitude: double
}

// QR_INFO
{
  info: string, // Encompasses the second line of the QR scan result
  date: string,
  time: string,
  device_id: string,
  sensor_id: string
}

//STATE_INFO
{
  lattitude: double,
  longtitude: double,
  altitude: double,
  yaw: double,
  pitch: double,
  roll: double
}

5. Make the page as easy as possible to read/understand.

If you think information can be better represented in a table, do that. Diagram, even better (http://draw.io is great for this). Feel free to also refer to other pre-existing pages if ur feeling uninspired