Improved documentation and README

mirrorcletech · Jan 8, 2025 · 33b89d1 · 33b89d1
1 parent 7e46733
commit 33b89d1
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -21,3 +21,34 @@ Playzer X is available directly from Mirrorcle by contacting sales@mirrorcletech
   <a href="https://www.mirrorcletech.com/wp/contact/" target="_blank"><img src="docs/_static/mirrorcle_logo_button.png" alt="Mirrorcle Logo" width="150"/></a>
   <a href="https://www.digikey.com/en/products/filter/evaluation-and-demonstration-boards-and-kits/787?s=N4IgjCBcpmAMVQGMoDMCGAbAzgUwDQgD2UA2iAGwAscVArAgLqEAOALlCAMpsBOAlgDsA5iAC%2BhALQRoIFJAw4CxMiABMVAOx0QjMfqA" target="_blank"><img src="docs/_static/digikey_logo_button.png" alt="Digi-Key Logo" width="150"/></a>
 </div>
+
+
+## Quick start
+
+
+
+
+## Overview 
+
+PlayzerX provides ease-of-access to the Playzer product line and VGLP architecture. The purpose of its simple analog or USB interface is to provide programmable beam steering.
+
+<img src="docs/_static/playzerx_ain_breakout_coin.png" alt="PlayzerX AIN breakout board" width="400"/>
+
+With very low power consumption, devoted mostly to the supply of the laser driver, and with a highly compact mechanical profile, Playzer X-Series is well-suited for the development of many laser pointing applications. Users command x-axis and y-axis angle of the Scan Module laser beam as well as output laser power of the beam. 
+
+Playzer X-Series provides simplified control of MEMS Mirror and Laser Beam with multiple interface modes:
+- Analog Input
+- USB (user switches to this Interface Mode with USB commands)
+
+For full specifications including the optical scanning angle (field of regard), laser power, and point-to-point scanning bandwidth,
+please see the [Mirrorcle Playzer X-Series - User Guide](https://mirrorcletech.com/pdf/PX/Mirrorcle_Playzer_X-Series_-_User_Guide.pdf).
+
+
+## Associated papers and application notes 
+
+Lovell, Daniel, et al. "Optical MEMS enable next generation solutions for robot vision and human-robot interaction." MOEMS and Miniaturized Systems XXI. Vol. 12013. SPIE, 2022. [Link to PDF](https://mirrorcletech.com/pdf/pub/Mirrorcle_-_Optical_MEMS_enable_next_generation_solutions.pdf)
+
+Kasturi, Abhishek, et al. "MEMS mirror module for programmable light system." MOEMS and Miniaturized Systems XVIII. Vol. 10931. SPIE, 2019. [Link to PDF](https://www.mirrorcletech.com/pdf/pub/Mirrorcle_-_MEMS_Mirror_Module_for_Programmable_light_System.pdf)
+
+
+
diff --git a/docs/PlayzerX-USB Serial Protocol.rst → docs/PlayzerX USB Serial Protocol.rst b/docs/PlayzerX-USB Serial Protocol.rst → docs/PlayzerX USB Serial Protocol.rst
@@ -1,4 +1,4 @@
-PlayzerX-USB Serial Protocol
+PlayzerX USB Serial Protocol
 ===============================
 
 Binary Mode Serial Command Structure

diff --git a/docs/_static/playzerx_ain_breakout_coin.png b/docs/_static/playzerx_ain_breakout_coin.png
diff --git a/docs/_static/playzerx_ain_moncha_lite.png b/docs/_static/playzerx_ain_moncha_lite.png
diff --git a/docs/_static/playzerx_ain_nidaq.png b/docs/_static/playzerx_ain_nidaq.png
diff --git a/docs/_static/playzerx_ain_pangolin.png b/docs/_static/playzerx_ain_pangolin.png
diff --git a/docs/_static/playzerx_usb.png b/docs/_static/playzerx_usb.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -32,7 +32,7 @@ Table of Contents
    :caption: Guides
 
    PlayzerX Programming Guide
-   PlayzerX-USB Serial Protocol
+   PlayzerX USB Serial Protocol
 
 .. toctree::
    :maxdepth: 2