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

@theatersoft/x10

v1.11.0

Published

Bus service module for X10 devices

Downloads

7

Readme

@theatersoft/x10

x10 is a Theatersoft bus service module that encapsulates the X10 home automation protocol to provide consistent device APIs for X10 control and state management.

The CM15A USB Transceiver is currently supported by encoding and decoding the interface streams from the USB controller using open sourced information about the X10 controller protocol.

X10 obviously has been legacy technology for a long time however I personally have X10 outdoor motion sensor floodlights that are still working reliably. This x10 module allows them to be used within the Theatersoft platform.

Installation

  1. Install Theatersoft.

  2. Add an X10 service configuration object to your site config.json to the services array of a hosts object. E.g:

      {
        "enabled": true,
        "module": "@theatersoft/x10",
        "export": "X10",
        "name": "X10",
        "config": {
          "vid": 3015,
          "pid": 1,
          "devices": [
            {
              "name": "Garage",
              "model": "VT38A",
              "id": "A3",
              "type": "Switch"
            },
            {
              "name": "Deck",
              "model": "PR511",
              "id": "A8",
              "type": "Switch"
            },
            {
              "name": "Deck Motion",
              "id": "A9",
              "type": "MotionSensor"
            }
          ]
        }
      }

    X10 cannot discover devices on its own so you'll need to preconfigure your own devices.

  3. npm run config deploy if you installed Theatersoft using @theatersoft/home; otherwise install @theatersoft/x10 and restart the server manually.

API

Actions control devices through the X10.dispatch (action :Action) API. Within the X10 module, an action would appear as {type: "ON", id: "A3"}. (Applications normally invoke actions indirectly through the device module, so the id would actually be X10.A3.)

State is accessed by listening to state signals on the x10 bus service object. A device state has the form:

    "X10.A3" : {
        name: "Garage",
        value: false,
        type: "Switch",
        id: "X10.A3",
        time: 1516156060728
    }

Virtual motion sensor device for VT38A Floodlight

Since this device reports its motion status on the same address that controls it, any motion state would normally only affect the switch state. Instead, add "model": "VT38A" to the device config to enable special handling:

  • automatically create an associated virtual MotionSensor device e.g. X10.A3.0
  • discriminate incoming commands between motion reports that update virtual device state and switch commands that update switch state