Skip to content

Commit

Permalink
On Request : Moved Topics Into README
Browse files Browse the repository at this point in the history
  • Loading branch information
ElectronicsArchiver committed Jun 27, 2022
1 parent f931d95 commit 4b8445a
Show file tree
Hide file tree
Showing 4 changed files with 169 additions and 163 deletions.
174 changes: 169 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,166 @@ to the devices listed here and are only provided
as a courtesy to our customers and the community.
```

</div>

<br>
<br>

---

<br>
<br>

# Product Identification

<br>

<div align = center>

<img
src = './images/Z-Wave%20vs%20Z-Wave%20Plus.png'
alt = 'Z-Wave vs Z-Wave Plus'
width = 568
/>

</div>

<br>
<br>

## Steps

<br>

1. **Identify the Product Brand.**

This can be found in the upper left corner and will say one of the following brands:

- <kbd> <br> Enbrighten-GE <br> </kbd>
- <kbd> <br> Honeywell <br> </kbd>
- <kbd> <br> UltraPro <br> </kbd>

<br>

2. **Identify your ZW Number.**

This can be found on the device itself, <br>
typically on the upper corner or back <br>
of the product itself.

<br>

3. **Identify your Product Number.**

These are typically on the back of the <br>
device in question followed by `-x`

#### Example

`46201-2` or `55256-1`

#### Note

These will not be 5 digits next to `PIN:`.

The Pin number is for Z-Wave S2 Security inclusion.


<br>
<br>

## Examples

<img
src = './images/example1.png'
alt = 'Example of a GE Branded Item'
width = 350
/>

<img
src = './images/example2.png'
alt = 'Example of an Enbrighten Branded Item'
width = 350
/>

<br>
<br>

## Folders

The folder structure for firmware is as follows:

`/zwave/<Brand>/<ZW Number>/<Product Number>/<Firmware Version>/<Firmware-File>`

**Example:**

`/zwave/Enbrighten-GE/14288 - In-Wall Smart Outlet/5.26/ZW1002_Enbrighten-GE_14288_5.hex`

Navigate to the correct section based on the <br>
ZW Number and Brand of your device, and <br>
the firmware version you wish to download.

<br>
<br>

## Warning

```
Downloading and applying the wrong firmware
can cause irreparable damage to your device.
Application of incorrect firmware will
void the warranty on your device.
Please make sure you are getting the correct product,
brand, and version number for your use case.
```

<br>
<br>

---

<br>
<br>

# Firmware Updates

<br>

## WiFi

WiFi products currently require the <br>
use of our app to update the firmware.

<br>
<br>

## Home Assistant

For this system you willl have to use the <br>
**[ZWaveJS2MQTT]** app to apply updates.

[![Button Addon]][Addon]

<br>
<br>

## Hubs

The exact instructions on how to update your firmware <br>
differ depending on the hub / system you are using.

*Please review the documentation provided by* <br>
*support staff of the hub / system in question.*

<br>

### Note

Some hubs / systems currently do not offer **OTA** updates, <br>
and any requests to add functionality to do so should be <br>
directed to the support for those specific systems.

<!--
Expand Down Expand Up @@ -138,14 +295,21 @@ as a courtesy to our customers and the community.

<!----------------------------------------------------------------------------->

[Button Identification]: https://img.shields.io/badge/Product_Identification-00A0DF?style=for-the-badge&logoColor=white&logo=GitBook
[Button Updating]: https://img.shields.io/badge/Updating_Firmware-37a779?style=for-the-badge&logoColor=white&logo=RSS

[Identification]: Topics/Product%20Identification.md 'How to determine what type of product you own.'
[Updating]: Topics/Firmware%20Update.md 'How to update the firmware on your device.'
[Identification]: #ProductIdentification 'How to determine what type of product you own.'
[Updating]: #FirmwareUpdate 'How to update the firmware on your device.'

[Firmware Request]: https://github.com/jascoproducts/firmware/issues/new?assignees=&labels=&template=firmware_request.yml&title=%5BFirmware+Request%5D%3A+BRAND+-+ZW+NUMBER+-+PRODUCT+NUMBER
[Bug Report]: https://github.com/jascoproducts/firmware/issues/new?assignees=&labels=&template=bug_report.yml&title=%5BBug+Report%5D%3A+BRAND+-+ZW+NUMBER+-+PRODUCT+NUMBER+-+FW+VERSION
[Addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=a0d7b954_zwavejs2mqtt 'Open this add-on in your Home Assistant instance.'
[ZWaveJS2MQTT]: https://zwave-js.github.io/zwavejs2mqtt/

[License]: #
[ZWave]: zwave


<!--------------------------------[ Buttons ]---------------------------------->

[Button Identification]: https://img.shields.io/badge/Product_Identification-00A0DF?style=for-the-badge&logoColor=white&logo=GitBook
[Button Updating]: https://img.shields.io/badge/Updating_Firmware-37a779?style=for-the-badge&logoColor=white&logo=RSS
[Button Addon]: https://my.home-assistant.io/badges/supervisor_addon.svg

49 changes: 0 additions & 49 deletions Topics/Firmware Update.md

This file was deleted.

108 changes: 0 additions & 108 deletions Topics/Product Identification.md

This file was deleted.

1 change: 0 additions & 1 deletion images/readme.md

This file was deleted.

0 comments on commit 4b8445a

Please sign in to comment.