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

skyline-iot-events

v1.0.5

Published

Firebase pubsub wrapper

Downloads

6

Readme

Skyline Iot Events


Allows multiple devices to talk to each other by subscribing and triggering events. Uses Firebase to implement PubSub.

Install

If you are using node or a javscript build process (browserify or webpack), just use the NPM module.

>> npm install --save skyline-iot-events

Otherwise, it also just works on any static HTML page. Just add a script reference to one of the builds in the /dist folder.

<script src='skyline-iot-events/dist/iotEvents.min.js'></script> 

Methods

Three methods are exposed to handle pubsub

  • iotEvents.trigger(key, payload) - Fire off an event of type 'key'. The payload is just an object, but please be a good citizen and at least add a source property.
  • iotEvents.subscribe(key, callback) - Listen for a device to call .trigger() on the specified key, your callback will be invoked with the triggering payload as the first argument.
  • iotEvents.unsubscribe(key, callback) - Stop listening to IOT events of the specified key.
  • iotEvents.subscribe('log', callback) - A quick little backdoor to listen to every event. Note: the first argument to your callback is an event not just the payload.

Example Usage

Check out the /demo folder for actual working examples... but here's the gist:

You could have a Raspberry PI running node.js to control your lights

var iotEvents = require('skyline-iot-events');

var handleLightToggle = function(payload) {
    var newValue = payload.status === "on" ? true : false;
    setLightValue(newValue);
    broadcastStatus();
};
var broadcastStatus = function() {
    var status = myLight.value ? "on" : "off"
    var payload = { source: "node-server", status: status };
    iotEvents.trigger("light-status", payload);
};

iotEvents.subscribe("toggle-light", handleLightToggle);

var setLightValue = function(newValue) {
    // device specific code to actually toggle light bulbs...
    myLight.value = newValue;
}

Then you could have a static HTML file (no server required!) that includes a reference to one of the builds in the /dist folder.

// === Turn the light on and off ===
var toggleLight = function(status) {
    var payload = { source: "html-page", status: status };
    window.iotEvents.trigger("toggle-light", payload);    
}
document.getElementById('turn-on-btn').onclick = function() { toggleLight("on"); }
document.getElementById('turn-off-btn').onclick = function() { toggleLight("off"); }


// === Real time display of the light's status ===
/*
 * There may be other things toggling the light, so we can see the 
 * realtime status (w/ web sockets) by subscribing to the event
*/
var showLightStatus = function(payload) {
    document.getElementById("light").innerHTML = payload.status;
};
// subscribe to events (fired from the node server in this example
window.iotEvents.subscribe('light-status', showLightStatus);