search

bitfocus / companion-module-elgato-keylight

Controls the Elgato Keylight and Ringlight family of devices
MIT License
3 stars 5 forks source link

Some simple documentation changes to HELP.md #2

Closed thomascantrellsea closed 3 years ago

thomascantrellsea commented 3 years ago

A few documentation changes as I tested the Key Light support. Nothing particularly urgent, and a few nits as well.

thomascantrellsea commented 3 years ago

If I'm supposed to squash commits here, still getting the hang of the git/github workflow here.

krocheck commented 3 years ago

I have to disagree with the "Static Network Configuration" block being added. Although accurate in a sense, I could argue a block like this should be present in every module's help file in Companion, though I know of none that include such copy. Thoughts?

krocheck commented 3 years ago

Sorry ... we only squash commits occasionally for the core application. I see no issue with a commit history like this for a straight merge into a module.

thomascantrellsea commented 3 years ago

That’s fine. I can pull the section on DHCP reservations if that’s what we decide :-)

I think what I’m trying to draw attention is I see no static network configuration options for Elgato key lights. So DHCP reservations are the only good way forward. Elgato’s tooling is heavy on the Bonjour-driven approach, so it isn’t particularly apparent what one needs to do. Most other gear at least has a workflow for a static IP address.

Thomas

krocheck commented 3 years ago

ahhh ... k. Can you remove the sub-bullet and simply have that copy follow the colon?

JTF4 commented 3 years ago

I would agree with the DCHP reservation part. However, I would add that it is recommended, but optional. (Especially if you have a crappy home router that changes the IP every day.)

krocheck commented 3 years ago

That would be an exceedingly crappy home router if its changing your IP by the day 😃

JTF4 commented 3 years ago

No joke, I know 3 people with a router that does that (4 if you count me when I was using the ISP provided router). And if you leave and rejoin the network it changes it. I use a UniFi dream machine at my house and it has been great.

thomascantrellsea commented 3 years ago

David,

Thanks for closing that out!

Have a little one who’s not sleeping - so my personal dev time was limited last night.

Thomas

Sent from my mobile phone.

On Nov 19, 2020, at 8:34 PM, David Stevens notifications@github.com wrote:



Merged #2https://github.com/bitfocus/companion-module-elgato-keylight/pull/2 into master.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://github.com/bitfocus/companion-module-elgato-keylight/pull/2#event-4019056988, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ARX74R7FEGVD7FWKJHWJ7HDSQXWTVANCNFSM4T22U2IQ.

JTF4 commented 3 years ago

You're very welcome! Thanks for your contribution!