Verification Request: homebridge-mac-wakeonlan

Open
#1,358 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
nodejs, typescript
Domain
devtools

Research direction

Start from the linked repository, https://github.com/DavideFarina2010/homebridge-mac-wakeonlan, and the checklist in the issue body. Check that the plugin is a dynamic platform plugin with a config.schema.json, that it writes no files, that sleepCommand runs only when configured, and that there are no analytics calls. Done means a maintainer-style verification comment on this issue, with each checklist item confirmed or flagged.

Written by the indexing model from the issue text.

Description

awaiting-final-review request-verification
Plugin Name

homebridge-mac-wakeonlan

Link To GitHub Repo

https://github.com/DavideFarina2010/homebridge-mac-wakeonlan

Plugin Icon (Optional)

No response

The plugin does not offer the same nor less functionality than that of any existing verified plugin.

🟢 Yes

The plugin successfully installs and does not start unless it is configured.

🟢 Yes

The plugin does not require the user to run Homebridge in a TTY or with non-standard startup parameters, even for initial configuration.

🟢 Yes

The plugin does not contain any analytics or calls that enable you to track the user.

🟢 Yes

If the plugin needs to write files to disk (cache, keys, etc.), it stores them inside the Homebridge storage directory.

🟢 Yes

The plugin does not throw unhandled exceptions, the plugin must catch and log its own errors.

🟢 Yes

More Information

homebridge-mac-wakeonlan is a dynamic platform plugin that exposes each Mac as a HomeKit switch and wakes it with Wake-on-LAN. It is published on npm with provenance (GitHub Actions, Trusted Publishing), has a GitHub release with notes for each version, a config.schema.json for the Homebridge UI, an MIT license and a README in English and Italian.

I know homebridge-wol (verified) also does Wake-on-LAN. The main differences are:

  • It is a dynamic platform plugin (devices are managed as platform accessories) instead of a static accessory plugin.
  • Real status can be checked by ping or by a TCP port (statusPort), for Macs whose firewall drops ping.
  • Magic packets go to the broadcast address of every local interface plus unicast to the Mac, which helps on networks with several subnets or VLANs.
  • Without an IP, the switch works as a pulse instead of showing a wrong state.
  • Optional sleepCommand to put the Mac to sleep from the Home app.

The plugin does not write files, does not make network calls other than the magic packets, ping and TCP checks to the configured Mac, and contains no analytics. It only runs sleepCommand if the user sets it in the config.

Dominant language
TypeScript
Stars
371
Forks
26
Avg merge
1h
Merged PRs (30d)
5

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from homebridge/plugins

All issues in homebridge/plugins

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.