Update README.md with more Zigbee information

[th3w1zard1]

There's too many issues related to Zigbee networks posted. Hopefully some more info in the README will help others configure their lights with this integration.

I agree configuring Zigbee2MQTT with Home Assistant is difficult enough. For me personally I used zigbee2mqtt with my original configuration for 3 months before I found this integration without issue, so I was surprised and quick to blame Adaptive Lighting when it had issues. I had a few problems such as report and optimistic turned off in configuration.yaml for my bulbs so they wouldn't update states immediately.

[th3w1zard1]

@basnijholt I'm having a problem with your .pre-commit-config.yaml

The Markdown Documentation says:

You can add footnotes to your content by using this bracket syntax:

Here is a simple footnote[^1].

A footnote can also have multiple lines[^2].

[^1]: My reference.
[^2]: To add line breaks within a footnote, prefix new lines with 2 spaces.
 This is a second line.

The footnote will render like this:

However pre-commit automatically removes any extra spaces at the end.

EDIT: I gave up and let pre-commit do its thing.

[th3w1zard1]

@basnijholt I'd also like to update the Issues template for new issues but I don't have the permissions.

[th3w1zard1]

@basnijholt Here's a template I wrote

Bug Reports:

If you'd instead like help using/configuring Adaptive Lighting, please open up a Q&A discussion thread here!

Please follow the general troubleshooting steps first:

• You've updated to the Latest Adaptive Lighting version in HACS
• You've read the Troubleshooting Section of the README
• (If using Zigbee2MQTT) You've read the Zigbee2MQTT troubleshooting guide on the README
• You've read the V2 Roadmap and confirmed your issue isn't a duplicate.

Please include the following in your post.

Issues missing this information will likely not be addressed

Your debug logs captured while the issue occurred. See here on how to enable debug logging:

• Your Adaptive Lighting configuration.

Adaptive Lighting configuration:

If using Zigbee2MQTT, please post your configuration files.
There are 3 files that are needed:

• devices.yaml
• groups.yaml
• configuration.yaml 🔺 Warning REMOVE ALL of the PERSONAL INFORMATION BELOW before posting 🔺
  • mqtt: server:
  • mqtt: user:
  • mqtt: password:
  • advanced: pan_id:
  • advanced: network_key:
  • anything in log_syslog if you use this

The brand and model number of your light(s) having a problem.

Please describe your bug here:

How to reproduce your issue?

Features:

Thank you for contributing your ideas! Please try to ensure:

• You've read the V2 Roadmap and confirmed your feature request isn't a duplicate. We'd like all conversations for a feature to be in one place.

Please note by far the quickest way to get a new feature in is to submit a Pull Request.

Please tell us about your feature here:

[th3w1zard1]

Please don't forget this PR!

[th3w1zard1]

@basnijholt could we please get a new issue template setup? If not the one above then just one that asks for basic info?

I feel like a broken record asking 'could you please post your config, debug logs, Al and hass version, and the type of lights you're using'. On every single issue thread.

One person opened an issue with two sentences. No information at all posted. I closed it as there's no reason to let most likely another duplicate thread with no info clutter up the priority issues from the list.

[basnijholt]

This is a great idea! I'll get to it ASAP. The template you suggested looks great.