npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

homie-dgram

v0.2.0

Published

Homie Datagram Protocol

Downloads

20

Readme

Homie Datagram Protocol

EXPERIMENTAL! DON'T EXPECT THIS TO BE STABLE!

This is a client for the Homie Datagram Protocol (HDP). A server implementation can be found here: homie/hdp

API

const hdpFactory = require('homie-dgram');
hdpFactory([opts]).then((hdpClient) => { ... });
  • opts has the following items:
    • port: UDP port to be bound. Default: 5001
    • mcast: Multicast group to join. Default: 'ff02::cafe'
  • hdpClient: Instance of HDPClient

Class: HDPClient

Event: discover

hdpClient.on('discover', (hdpDevice) => { ... });

Is fired once a HDPDevice has been discovered.

Method: triggerDiscovery()

hdpClient.triggerDiscovery([opts]);

Triggers discovery by requesting the current state of all reachable HDP devices.

opts has the following options:

  • port: hdpDevice's port. Default: 5000
  • mcast: Multicast address for the request. Default: 'ff02::1'.
  • iface: Network interface to query. Default: all network interfaces with IPv6 connectivity.

Method: get()

hdpClient.get(cpuid[, timeout]).then((hdpDevice) => { ... });
  • cpuid: Hex string of the hdpDevice's CPUID
  • timeout: Amount of millisecods to wait for the given device to be discovered. Default: 20000.
  • hdpDevice: Instance of HDPDevice

Method: getAll()

const hdpDevices = hdpClient.getAll();
  • hdpDevices: Array of HDPDevice that have been discovered, yet.

Method: close()

hdpClient.close().then(() => { ... });

Closes the network socket.

Class: HDPDevice

Property: cpuid

CPUID of hdpDevice.

Property: uptime

Uptime in milliseconds of the hdpDevice.

Method: get()

const hdpEndpoint = hdpDevice.get(name)
  • name: Name of the endpoint
  • hdpEndpoint: Instance of HDPEndpoint

Class HDPEnpoint

Property: name

Name of the hdpEndpoint.

Property: type

Type of the hdpEndpoint.

Property: writable

Flag indicating that the endpoint is writable.

Property: readable

Flag indicating that the endpoint is readable.

Event: change

hdpEndpoint.on('change', (newVal, oldVal) => { ... });

Is fired once the endpoint's value has changed.

  • newVal: Endpoints new value
  • oldVal: Endpoints old value

Method: get()

val = hdpEndpoint.get();

Precondition: hdpEndpoint.readable === true;

Gets the current value of the endpoint.

Method: set()

await hdpEndpoint.set(val);

Precondition: hdpEndpoint.writable === true;

Writes the value of the endpoint.