Module `rpm_status_leds` example config wrong?

[patschi]

As per example file, following notes are present (also mentioned in other files the same way):

wifi-fancontroller/modules/rpm_status_leds.yaml

Lines 6 to 13 in a28ba2e

	# Usage:
	# packages:
	# rpm_status_leds:
	# url: https://github.com/zeroflow/wifi-fancontroller
	# files: [modules/rpm_status_leds.yaml]
	# ref: main
	# vars:
	# full_rpm: "2500" # RPM value considered as 100% speed (green LED)

But when using above, ESPHome's editor doesnt' seem to like vars::

I have been using this one before and seems to work:

  rpm_status_leds:
    url: https://github.com/zeroflow/esphome-fancontroller
    files: 
      - path: modules/rpm_status_leds.yaml
        vars:
          full_rpm: 2000 # considered 100% speed

Am I wrong, or the example?

[zeroflow]

Hi,

Thanks for doing a lot of errorchecking.
Looks like this issue also causes #22

Remote files and variables seem to need the more verbose config you already posted.

packages:
  # Include the hardware-specific configuration
  hardware:
    url: https://github.com/zeroflow/wifi-fancontroller
    files: [hardware-rev-3.1.yaml]
    ref: main

  rpm_status_leds:
    url: https://github.com/zeroflow/wifi-fancontroller 
    files: 
      - path: modules/rpm_status_leds.yaml
        vars: 
          full_rpm: "2500"  # RPM value considered as 100% speed (green LED) 
    ref: main 

With this change, the module starts working.
The example I used for testing (with-rgb-status-leds-rev-3.1.yaml) did not include any vars and thus worked.
I'll incorporate this into all the neccesary files.

Thank you!

[patschi]

Yep, indeed. Those to issues were related - sorry for creating two issues then!
Got it working with above too.

Nitpicking:
Personally I'd use url, then ref and files - getting more specific. Also, it looks better than using ref: main in the last line after files IMHO.

So:

  rpm_status_leds:
    url: https://github.com/zeroflow/wifi-fancontroller
    ref: main 
    files: 
      - path: modules/rpm_status_leds.yaml

Compared to:

  rpm_status_leds:
    url: https://github.com/zeroflow/wifi-fancontroller 
    files: 
      - path: modules/rpm_status_leds.yaml
    ref: main 

[zeroflow]

That makes sense and is a lot more cleaner. Also from a logical sense: Repo > Branch > File
Thank you.