Skip to content

Commit

Permalink
Improved Duo updating guide
Browse files Browse the repository at this point in the history
  • Loading branch information
LivingSynthesis committed Jan 17, 2025
1 parent 79fe549 commit 8125fa2
Show file tree
Hide file tree
Showing 6 changed files with 179 additions and 241 deletions.
2 changes: 1 addition & 1 deletion docs/chromadeck_upgrade_guide.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Chromadeck Upgrade Guide
nav_order: 4
nav_order: 2
parent: Chromadeck Guide
---

Expand Down
121 changes: 121 additions & 0 deletions docs/duo_connecting_or_upgrading_guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
---
layout: default
title: Duo Connecting or Updating Guide
nav_order: 2
parent: Duo Guide
---
<style>
.warning-box {
background-color: rgba(255,255,0,.25);
border: 1px solid #ddd;
border-radius: 8px;
padding: 15px;
margin: 20px 0;
box-shadow: 0 4px 6px rgba(0, 0, 0, 0.1);
}
.info-box strong {
color: #0056b3;
}
</style>

<div style="text-align: center; margin: 20px">
<h1 style="color:orange;">⚠ <b style="color:red;">Warning</b> ⚠<br></h1>
</div>

{: .warning}
Connecting Duos to a Chromadeck <i>can</i> cause damage to them if you do not follow instructions!
Be patient, careful, and double-check instuctions before proceeding.
StoneOrbits is not responsible for damage caused this way.


---

# Preparing Duos for Connecting or Updating

<img src="assets/images/duo-logo-square-512.png" style="max-width: 250px; width: 40%; float: right; margin-bottom: 20px">

Both a **Chromadeck** and a **Chromalink** cable are necessary to connect to or update a Duo.

Before connecting to or updating Duo firmware, always ensure the **Chromadeck** is [up to date](chromadeck_upgrade_guide.html)
first.
<div style="margin-left: 50px; margin-right: 50px; margin-bottom: 30px;" markdown="1">

- **Use a data-capable USB cable, power-only cables won't work.**
- Windows will notify upon successful connection
- Mac may work but is not officially supported.
</div>

With your Duo, Chromadeck, Chromalink, Computer, and USB-C cable ready, proceed to the next step.

---

**Remove the Casing**

- Start by carefully removing the Duo from it's case. It should come out with little resistance.
- If you find it does not come out easily, check to see if the bulb is caught on the opening as shown in the 2nd gif.

<div style="text-align: center; margin: 5px">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/duo-case-removal.gif">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/duo-case-removal-2.gif">
</div>

---

**Removing the Battery**


<div style="text-align: center; margin: 5px">
<p style="color:white;"><span style="color:yellow;">⚠</span> <b>Warning</b> <span style="color:yellow;">⚠</span><br>
<strong>This is a potentially dangeous step!</strong></p>
</div>

{: .warning}
Failure to remove the battery before connecting to the Chromalink will cause the battery's lifespan to shorten dramatically.
Removing the battery incorrectly can break the battery connector, rendering the chip broken and unrepairable.
StoneOrbits is not responsible for any damage to the Duo or battery caused this way.


- In order to safely update the Duo, the battery must be carefully disconnected first.
- **Gently** and **peel** the Duo battery away from the Duo like shown below.
<div style="text-align: center; margin: 5px">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/battery-removal-1.gif">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/battery-removal-2.gif">
</div>

---

**Setting up the Chromadeck and Chromalink**
- Connect the **Chromalink** cable to the **Chromadeck**, then plug the **Chromadeck** into the PC and power it on.
<div style="text-align: center; margin: 5px">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/connect-chromalink.gif">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/connect-chromadeck.gif">
</div>

---

**Connecting the Duo to the Chromalink**
- Seat the Duo into the **Chromalink** dock and slide it into place like shown below

<div style="text-align: center; margin: 20px">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/insert-dock-1.gif">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/insert-dock-2.gif">
</div>

---

**Verify Connection**

- To verify the Duo is securely connected to the Chromalink, press the button to turn it on.
- If it does not turn on, make sure your Chromadeck is on first and review the previous steps to make sure there are no mistakes.

---

<div style="text-align: center; margin-top: 30px;">
<p><h3 style="color: white;">Congratulations!</h3> Your Duo is ready for connecting and updating!</p>
</div>

# Next Steps
- [Updating your Duo](duo_upgrade_guide.html) to the latest version.
- [Connecting your Duo](duo_connection_guide.html) to Lightshow.lol.
- [Reassembling your Duo](duo_reassembly_guide.html).
---
140 changes: 19 additions & 121 deletions docs/duo_connection_guide.md
Original file line number Diff line number Diff line change
@@ -1,109 +1,16 @@
---
layout: default
title: Duo Connection Guide
nav_order: 3
parent: Duo Guide
nav_order: 2
parent: Duo Connecting or Updating Guide
---

<div style="text-align: center; margin: 20px">
<h1 style="color:orange;">⚠ <b style="color:red;">Warning</b> ⚠<br></h1>
</div>

{: .warning}
Connecting Duos to a Chromadeck <i>can</i> cause damage to them if you do not follow instructions!
Be patient, careful, and double-check instuctions before proceeding.
StoneOrbits is not responsible for damage caused this way.

---

# Chromalink Guide

<img src="assets/images/duo-logo-square-512.png" style="max-width: 250px; width: 40%; float: right; margin-bottom: 20px">

This process is nearly identical to updating a Duo until the final steps. Please make sure your Duo is [up to date](duo_upgrade_guide.html) before following this connection guide carefully.

Both a **Chromadeck** and a **Chromalink** cable are necessary to connect a Duo to Lightshow.lol.

Before connecting your Duo, always ensure the **Chromadeck** is [up to date](chromadeck_upgrade_guide.html)
first.
<div style="margin-left: 50px; margin-right: 50px; margin-bottom: 30px;" markdown="1">

- **Use a data-capable USB cable, power-only cables won't work.**
- Windows will notify upon successful connection
- Mac may work but is not officially supported.
</div>

With your Duo, Chromadeck, Chromalink, Computer, and USB-C cable ready, proceed to the next step.

---

**Remove the Casing**
# Connecting Your Duo

- Start by carefully removing the Duo from it's case. It should come out with little resistance.
- If you find it does not come out easily, check to see if the bulb is caught on the opening as shown in the 2nd gif.

<div style="text-align: center; margin: 5px">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/duo-case-removal.gif">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/duo-case-removal-2.gif">
</div>

---

**Removing the Battery**


<div style="text-align: center; margin: 5px">
<p style="color:white;"><span style="color:yellow;">⚠</span> <b>Warning</b> <span style="color:yellow;">⚠</span><br>
<strong>This is a potentially dangeous step!</strong></p>
</div>

{: .warning}
Failure to remove the battery before connecting to the Chromalink will cause the battery's lifespan to shorten dramatically.
Removing the battery incorrectly can break the battery connector, rendering the chip broken and unrepairable.
StoneOrbits is not responsible for any damage to the Duo or battery caused this way.

- In order to safely update the Duo, the battery must be carefully disconnected first.
- **Gently** and **peel** the Duo battery away from the Duo like shown below.
<div style="text-align: center; margin: 5px">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/battery-removal-1.gif">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/battery-removal-2.gif">
</div>

---

**Setting up the Chromadeck and Chromalink**
- Connect the **Chromalink** cable to the **Chromadeck**, then plug the **Chromadeck** into the PC and power it on.
<div style="text-align: center; margin: 5px">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/connect-chromalink.gif">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/connect-chromadeck.gif">
</div>
Your Duo must be up to date to connect successfully. Make sure you [update your Duo](duo_upgrade_guide.html) before continuing with this guide.

---

**Connecting the Duo to the Chromalink**
- Seat the Duo into the **Chromalink** dock and slide it into place like shown below

<div style="text-align: center; margin: 20px">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/insert-dock-1.gif">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/insert-dock-2.gif">
</div>

---

**Verify Connection**

- To verify the Duo is securely connected to the Chromalink, press the button to turn it on.
- If it does not turn on, review the previous steps to make sure there are no mistakes.
---

&nbsp;

**Connecting the Duo**





- Navigate a **Google Chrome** browser to [lightshow.lol](https://lightshow.lol) and click the **Connect Device** USB icon:

<div style="text-align: center; margin: 20px">
Expand All @@ -120,18 +27,19 @@ StoneOrbits is not responsible for any damage to the Duo or battery caused this

- With the **Chromadeck** connected to lightshow.lol, two new panels will be visible: **Device Updates** & **Chromalink Duo**

<div style="text-align: center; margin: 5px">
{: .note }
<b style="color:white;">Note: </b> If you haven't <a href="chromadeck_upgrade_guide.html">updated the Chromadeck</a> yet, do it <b style="color:white;">now</b>!</p>


<div style="text-align: center; margin: 5px">
<img style="max-width:280px;" src="assets/images/lightshow-lol-chromadeck-update-done.png">
<img style="max-width:260px;max-height:190px;" src="assets/images/lightshow-lol-chromalink-duo-basic.png">
</div>

- If the **Chromadeck** firmware is up to date, then press the **Connect Duo** button in the **Chromalink Duo Panel** to connect the Duo:

<div style="text-align: center; margin-top: 20px;">
<p><b style="color: white;">Note</b>: It is necessary for your Duo to be up to date before Connecting!</p>
</div>
{: .note }
<p><b style="color: white;">Note</b>: It is necessary for your Duo to be up to date before Connecting!</p>

<div style="text-align: center; margin: 20px">
<img style="max-width:260px;max-height:260px;" src="assets/images/lightshow-lol-chromalink-duo-basic.png">

Expand All @@ -144,29 +52,19 @@ Check out the [Lightshow.lol Guide](lightshow_lol.html) to see all the awesome t

---

**Puting everything Back Together**

- remove the **Duo** from the **Chromalink** and reconnect the battery. Make sure the corners of the connector are flush for a reliable connection.
- click the button to power on the Duo and verify the battery is fully connected.
# Troubleshooting

- If it works, insert it back into the case. Otherwise recheck the battery connector.
**The Duo doesn't turn on**
Make sure the duo was properly seated into the Chromalink.

<div style="text-align: center; margin: 20px">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/duo-battery-connect.gif">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/duo-case-insertion.gif">
</div>
**It doesn't work!**
If you encounter any issues, try refreshing the page and unplugging and reconnecting your chromadeck. Also make sure the power switch is in the ON position while it is plugged in.

<div style="text-align: center; margin-top: 30px;">
<p><b style="color: white;">Congratulations</b> You have successfully updated the Duo Firmware!</p>
</div>
**It still doesn't work!**
Join our [discord](https://discord.gg/4R9at8S8Sn) and ask for help!

---

# Troubleshooting

**It doesn't work!**
## Reassembly
Once you've finished editing your modes, make sure you [put everything back together](duo_reassembly_guide.html).

If you encounter any issues, try refreshing the page and unplugging and reconnecting your chromadeck. Also make sure the power switch is in the ON position while it is plugged in.

**It still doesn't work!**
Join our [discord](https://discord.gg/4R9at8S8Sn) and ask for help!
2 changes: 1 addition & 1 deletion docs/duo_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ Welcome to the Duo LED Guide, this page aims to get you up and running as fast a
<div class="next-steps">
<ul>
<li><a href="basic_usage.html">Explore Vortex Engine</a>: Learn key terms, concepts, and how to use on-device menus.</li>
<li><a href="duo_upgrade_guide.html">Upgrade Your Device</a>: Ensure your device has the latest firmware for optimal performance.</li>
<li><a href="duo_connecting_or_upgrading_guide.html">Upgrade Your Device</a>: Ensure your device has the latest firmware for optimal performance.</li>
</ul>
</div>

Expand Down
22 changes: 22 additions & 0 deletions docs/duo_reassembly_guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
layout: default
title: Duo Reassembly Guide
nav_order: 3
parent: Duo Connecting or Updating Guide
---

# Reassembling Your Duo

- remove the **Duo** from the **Chromalink** and reconnect the battery. Make sure the corners of the connector are flush for a reliable connection.
- click the button to power on the Duo and verify the battery is fully connected.

- If it works, insert it back into the case. Otherwise recheck the battery connector.

<div style="text-align: center; margin: 20px">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/duo-battery-connect.gif">
<img style="max-width:260px;border-radius:5px;border:1px solid gray;" src="assets/images/duo-case-insertion.gif">
</div>

<div style="text-align: center; margin-top: 30px;">
<p><b style="color: white;">Congratulations</b> Your Duo is ready to go!</p>
</div>
Loading

0 comments on commit 8125fa2

Please sign in to comment.