Skip to content

Commit 62d0a02

Browse files
daniellovelldaniellovell
committed
AIN integrations in README and index rst
1 parent 33b89d1 commit 62d0a02

File tree

2 files changed

+92
-2
lines changed

2 files changed

+92
-2
lines changed

‎README.md

+19
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,25 @@ Playzer X-Series provides simplified control of MEMS Mirror and Laser Beam with
4343
For full specifications including the optical scanning angle (field of regard), laser power, and point-to-point scanning bandwidth,
4444
please see the [Mirrorcle Playzer X-Series - User Guide](https://mirrorcletech.com/pdf/PX/Mirrorcle_Playzer_X-Series_-_User_Guide.pdf).
4545

46+
### PlayzerX Analog Input
47+
48+
The Analog Input configuration of the Playzer X allows users to interface via three channels of analog signals, allowing control of laser beam direction (X,Y or azimuth and elevation) and laser beam intensity. Use of the PlayzerX-AIN requires user's own hardware such as e.g.: data acquisition card (NIDAQ or similar), FPGA/MCU based embedded systems, or bench-top lab equipment. This Playzer system cannot be directly controlled via a software interface as it takes voltages as inputs.
49+
50+
Electrical specifications such as power supply, voltage input ranges, and current draw are detailed in the [Mirrorcle Playzer X-Series User Guide](https://mirrorcletech.com/pdf/PX/Mirrorcle_Playzer_X-Series_-_User_Guide.pdf).
51+
52+
#### Example integrations with third-party hardware
53+
54+
The [Moncha Lite from Showtacle](https://www.showtacle.jp/v18/lasershowsoftware/hardware/moncha/moncha-lite/)
55+
56+
<img src="docs/_static/playzerx_ain_moncha_lite.png" alt="PlayzerX AIN breakout board" width="600"/>
57+
58+
The [FB3QS with QuickShow from Pangolin](https://pangolin.com/products/fb3qs-with-quickshow)
59+
60+
<img src="docs/_static/playzerx_ain_pangolin.png" alt="PlayzerX AIN breakout board" width="600"/>
61+
62+
The [USB X-Series NI-DAQ Controller from National Instruments](https://www.ni.com/en/support/documentation/supplemental/09/what-is-ni-x-series-.html)
63+
64+
<img src="docs/_static/playzerx_ain_nidaq.png" alt="PlayzerX AIN breakout board" width="600"/>
4665

4766
## Associated papers and application notes
4867

‎docs/index.rst

+73-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,23 @@
1-
PlayzerX documentation
1+
PlayzerX Documentation
22
======================
33

44
.. raw:: html
55

66
<img src="_static/playzerx_logo.png" alt="PlayzerX Logo" width="400"/>
77

8+
.. raw:: html
9+
10+
<div style="display: flex; gap: 10px; margin: 20px 0;">
11+
<a href="https://mirrorcletech.github.io/playzerx/">
12+
<img src="https://img.shields.io/badge/%F0%9F%93%93-Documentation-blue?labelColor=white" alt="Documentation"/>
13+
</a>
14+
<a href="https://github.com/mirrorcletech/playzerx/actions/workflows/main.yml">
15+
<img src="https://github.com/mirrorcletech/playzerx/actions/workflows/main.yml/badge.svg" alt="PlayzerX CI"/>
16+
</a>
17+
<a href="https://github.com/mirrorcletech/playzerx/actions/workflows/build-docs.yml">
18+
<img src="https://github.com/mirrorcletech/playzerx/actions/workflows/build-docs.yml/badge.svg" alt="Build documentation"/>
19+
</a>
20+
</div>
821

922
The Playzer X-Series (or “PlayzerX”) provides developers, makers, engineers,
1023
and students easy access to Playzer technology and its underlying VGLP
@@ -15,7 +28,7 @@ to control the laser beam by software via USB.
1528
- Monochrome Playzer X-Series, Part Numbers: PX1-[R/G/B/V]
1629
- RGB Playzer X-Series, Part Number: PX1-RGB
1730

18-
Playzer X is available directly from Mirrorcle by contacting sales@mirrorcletech.com, or from DigiKey (links below)
31+
Playzer X is available directly from Mirrorcle by contacting `sales@mirrorcletech.com <mailto:sales@mirrorcletech.com>`_, or from DigiKey (links below)
1932

2033
.. raw:: html
2134

@@ -24,6 +37,64 @@ Playzer X is available directly from Mirrorcle by contacting sales@mirrorcletech
2437
<a href="https://www.digikey.com/en/products/filter/evaluation-and-demonstration-boards-and-kits/787?s=N4IgjCBcpmAMVQGMoDMCGAbAzgUwDQgD2UA2iAGwAscVArAgLqEAOALlCAMpsBOAlgDsA5iAC%2BhALQRoIFJAw4CxMiABMVAOx0QjMfqA" target="_blank"><img src="_static/digikey_logo_button.png" alt="Digi-Key Logo" width="150"/></a>
2538
</div>
2639

40+
Quick start
41+
-----------
42+
43+
Overview
44+
----------
45+
46+
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.
47+
48+
.. image:: _static/playzerx_ain_breakout_coin.png
49+
:alt: PlayzerX AIN breakout board
50+
:width: 400px
51+
52+
53+
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.
54+
55+
Playzer X-Series provides simplified control of MEMS Mirror and Laser Beam with multiple interface modes:
56+
- Analog Input
57+
- USB (user switches to this Interface Mode with USB commands)
58+
59+
For full specifications including the optical scanning angle (field of regard), laser power, and point-to-point scanning bandwidth,
60+
please see the `Mirrorcle Playzer X-Series - User Guide <https://mirrorcletech.com/pdf/PX/Mirrorcle_Playzer_X-Series_-_User_Guide.pdf>`_.
61+
62+
PlayzerX Analog Input
63+
^^^^^^^^^^^^^^^^^^^^^^
64+
65+
The Analog Input configuration of the Playzer X allows users to interface via three channels of analog signals, allowing control of laser beam direction (X,Y or azimuth and elevation) and laser beam intensity. Use of the PlayzerX-AIN requires user's own hardware such as e.g.: data acquisition card (NIDAQ or similar), FPGA/MCU based embedded systems, or bench-top lab equipment. This Playzer system cannot be directly controlled via a software interface as it takes voltages as inputs.
66+
67+
Electrical specifications such as power supply, voltage input ranges, and current draw are detailed in the `Mirrorcle Playzer X-Series User Guide <https://mirrorcletech.com/pdf/PX/Mirrorcle_Playzer_X-Series_-_User_Guide.pdf>`_.
68+
69+
Example integrations with third-party hardware
70+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
71+
72+
The `Moncha Lite from Showtacle <https://www.showtacle.jp/v18/lasershowsoftware/hardware/moncha/moncha-lite/>`_
73+
74+
.. image:: _static/playzerx_ain_moncha_lite.png
75+
:alt: PlayzerX AIN Moncha Lite integration
76+
:width: 600px
77+
78+
The `FB3QS with QuickShow from Pangolin <https://pangolin.com/products/fb3qs-with-quickshow>`_
79+
80+
.. image:: _static/playzerx_ain_pangolin.png
81+
:alt: PlayzerX AIN Pangolin integration
82+
:width: 600px
83+
84+
The `USB X-Series NI-DAQ Controller from National Instruments <https://www.ni.com/en/support/documentation/supplemental/09/what-is-ni-x-series-.html>`_
85+
86+
.. image:: _static/playzerx_ain_nidaq.png
87+
:alt: PlayzerX AIN NI-DAQ integration
88+
:width: 600px
89+
90+
Associated papers and application notes
91+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
92+
93+
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>`_
94+
95+
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>`_
96+
97+
2798
Table of Contents
2899
------------------
29100

0 commit comments

Comments
 (0)