diff --git a/docs/chromadeck_upgrade_guide.md b/docs/chromadeck_upgrade_guide.md index a0e16f3ef4..17fd278c0e 100644 --- a/docs/chromadeck_upgrade_guide.md +++ b/docs/chromadeck_upgrade_guide.md @@ -1,7 +1,7 @@ --- layout: default title: Chromadeck Upgrade Guide -nav_order: 4 +nav_order: 2 parent: Chromadeck Guide --- diff --git a/docs/duo_connecting_or_upgrading_guide.md b/docs/duo_connecting_or_upgrading_guide.md new file mode 100644 index 0000000000..d7d87ddfd0 --- /dev/null +++ b/docs/duo_connecting_or_upgrading_guide.md @@ -0,0 +1,121 @@ +--- +layout: default +title: Duo Connecting or Updating Guide +nav_order: 2 +parent: Duo Guide +--- + + +
+

Warning

+
+ +{: .warning} +Connecting Duos to a Chromadeck can 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 + + + +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. +
+ +- **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. +
+ +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. + +
+ + +
+ +--- + +**Removing the Battery** + + +
+

Warning
+ This is a potentially dangeous step!

+
+ +{: .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. +
+ + +
+ +--- + +**Setting up the Chromadeck and Chromalink** + - Connect the **Chromalink** cable to the **Chromadeck**, then plug the **Chromadeck** into the PC and power it on. +
+ + +
+ +--- + +**Connecting the Duo to the Chromalink** + - Seat the Duo into the **Chromalink** dock and slide it into place like shown below + +
+ + +
+ +--- + +**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. + +--- + +
+

Congratulations!

Your Duo is ready for connecting and updating!

+
+ +# 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). + --- diff --git a/docs/duo_connection_guide.md b/docs/duo_connection_guide.md index 99d413a8ce..95c7e80608 100644 --- a/docs/duo_connection_guide.md +++ b/docs/duo_connection_guide.md @@ -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 --- -
-

Warning

-
- -{: .warning} -Connecting Duos to a Chromadeck can 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 - - - -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. -
- -- **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. -
- -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. - -
- - -
- ---- - -**Removing the Battery** - - -
-

Warning
- This is a potentially dangeous step!

-
- -{: .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. -
- - -
- ---- - -**Setting up the Chromadeck and Chromalink** - - Connect the **Chromalink** cable to the **Chromadeck**, then plug the **Chromadeck** into the PC and power it on. -
- - -
+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 - -
- - -
- ---- - -**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. - --- - -   - -**Connecting the Duo** - - - - - - Navigate a **Google Chrome** browser to [lightshow.lol](https://lightshow.lol) and click the **Connect Device** USB icon:
@@ -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** -
+{: .note } Note: If you haven't updated the Chromadeck yet, do it now!

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

Note: It is necessary for your Duo to be up to date before Connecting!

-
+{: .note } +

Note: It is necessary for your Duo to be up to date before Connecting!

+
@@ -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. -
- - -
+**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. -
-

Congratulations You have successfully updated the Duo Firmware!

-
+**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! \ No newline at end of file diff --git a/docs/duo_guide.md b/docs/duo_guide.md index 44452358b5..a84329873a 100644 --- a/docs/duo_guide.md +++ b/docs/duo_guide.md @@ -151,7 +151,7 @@ Welcome to the Duo LED Guide, this page aims to get you up and running as fast a
diff --git a/docs/duo_reassembly_guide.md b/docs/duo_reassembly_guide.md new file mode 100644 index 0000000000..83e530c895 --- /dev/null +++ b/docs/duo_reassembly_guide.md @@ -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. + +
+ + +
+ +
+

Congratulations Your Duo is ready to go!

+
\ No newline at end of file diff --git a/docs/duo_upgrade_guide.md b/docs/duo_upgrade_guide.md index d713aa12af..281e3cf274 100644 --- a/docs/duo_upgrade_guide.md +++ b/docs/duo_upgrade_guide.md @@ -1,8 +1,8 @@ --- layout: default -title: Duo Upgrade Guide -nav_order: 2 -parent: Duo Guide +title: Duo Update Guide +nav_order: 1 +parent: Duo Connecting or Updating Guide --- -
-

Warning

-
- -{: .warning} -Connecting Duos to a Chromadeck can 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. - - ---- - -# Duo Upgrade Guide - - - -Both a **Chromadeck** and a **Chromalink** cable are necessary to update the Duo. - -Before updating Duo firmware, always ensure the **Chromadeck** is [up to date](chromadeck_upgrade_guide.html) - first. -
- -- **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. -
- -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. - -
- - -
- ---- - -**Removing the Battery** - - -
-

Warning
- This is a potentially dangeous step!

-
- -{: .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. -
- - -
- ---- - -**Setting up the Chromadeck and Chromalink** - - Connect the **Chromalink** cable to the **Chromadeck**, then plug the **Chromadeck** into the PC and power it on. -
- - -
- ---- - -**Connecting the Duo to the Chromalink** - - Seat the Duo into the **Chromalink** dock and slide it into place like shown below - -
- - -
- ---- - -**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. - ---- - -   -**Updating the Duo** +# Updating Your Duo - Navigate a **Google Chrome** browser to [lightshow.lol](https://lightshow.lol) and click the **Connect Device** USB icon: @@ -130,21 +37,24 @@ 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** -
- Note: If you haven't updated the Chromadeck yet, do it now!

- +{: .note } +Note: If you haven't updated the Chromadeck yet, do it now!

+ +
- If the **Chromadeck** firmware is up to date, then press the **Update Firmware** button in the **Chromalink Duo Panel** to update the Duo: -
-

Note: It is unnecessary to press Connect Duo when updating Firmware!

-
+{: .note } +

Note: It is unnecessary to press Connect Duo when updating Firmware!

+
+ + You should see the blue bar on your screen fill with progress and your Chromadeck will fill with green LEDs to represent the progress as well.
- Let the flash complete. @@ -153,29 +63,16 @@ StoneOrbits is not responsible for any damage to the Duo or battery caused this - If it powers on successfully, proceed to the next step or go to the [Chromalink Guide](chromalink_guide.html) to see how to use your Duo with Lightshow.lol - --- - - **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. - -- If it works, insert it back into the case. Otherwise recheck the battery connector. - -
- - -
-

Congratulations You have successfully updated the Duo Firmware!

---- + --- # Troubleshooting **The Duo doesn't turn on** + Repeat the process if the Duo doesn't work, make sure the duo was properly seated into the Chromalink and the progress bar in the Chromalink window fills. **The progress bar doesn't start and the Chromadeck LEDs are yellow**