Skip to content

Latest commit

 

History

History
49 lines (37 loc) · 2.33 KB

module_housing.md

File metadata and controls

49 lines (37 loc) · 2.33 KB

Synopsis

A short introduction to the module's purpose

This module acts as the physical housing of all lidar components. Its primary functions are:

  1. The protection of all modules from the environment (e.g. waterproofing, heating, cooling)
  2. From mechanical interference (e.g. by preventing tools, fingers, animals, etc. from gaining access)
  3. From radio-frequency interference (e.g. by providing a Faraday cage around the modules)

The housing is often a closed box that is sealed against the elements.

It is possible that there may be more than one housing in the lidar device, and that the housing is integrated with the different modules.

Glossary of Terms

A list of terms that are specific to this module

  1. blah
  2. blah

Interfaces

How the module is linked to other parts of the OpenLidar architecture

Safety

A list of possible safety issues related to the module and suggestions for mitigating any possible risks

Opening the housing could expose internal components to the weather, or expose users to high voltages, laser light, or other risks. The housing should therefore be interconnected with the rest of the device to help ensure safe operation.

FAQ

This module is...

A list of things that do belong to the module

This module is not...

A list of things that are not part of the module. Use issues, etc. for evidence

Documentation

How a specific implementation of this module should be documented. It should be adjusted for each module as required.

The following documentation is required (marked with a star) or suggested.

  • High Level Overview discusses the main functions of the module and its constituent components.
  • Contacts information about the contact person or organzation responsible for this module.
  • Design Space discusses the operating conditions for the module.
  • Detailed Information discusses the details of the module, including suggestions that may be implemented to accomplish its roles in the lidar system.
    • Hardware
    • Software
    • Controller
    • Interfaces discusses how the module is connected to other parts of the OpenLidar architecture.
  • Safety includes all applicable safety information
  • References provide links to articles and other relevant information.

Known examples of this module

A list of projects or products that have implemented this module