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

hoffmation-base

v3.0.0-beta.4

Published

Base Libraries and functions for own Hoffmation projects

Downloads

1,506

Readme

Hoffmation-Base

DeepSource

A home automation library specialized for Zigbee and Homematic IP devices in combination with ioBroker.

What does it do?

This project serves as library for home automation projects. It provides services, models and utilities necessary to interact with rooms and smart devices via iobroker, but also to connect them to other services for textual/audio/visual notifications or really just any code or service you want the devices to connect to.

Built on other open source projects that take care of the technical level, this project is made to provide a tool for the coding on the logical level. It is built as base to write automation code independent of the ioBroker user interface and currently provides support for the interaction with devices specified in src/server/devices and services that can be found in src/server/services.

Those include, but are not limited to:

  • Devices: Motion/Presence sensors, window handles, heating elements, lamps and dimmers, shutters, door contact sensors, physical buttons/switches, power sockets
  • Services: Interaction service for a telegram bot, weather, sonos control, waste calendar

How can I use it?

This library can be used in conjunction with or as addition to own base projects, but it's intended to be used with the configuration project Hoffmation-Express which uses this library via a npm package.

Whether you use it with Hoffmation-Express or with your own controller code, make sure you pass a valid config file (see src/server/config/private for an example) and a valid ioBroker device tree (you can find more information about that in the Hoffmation-Express project).

Base requirements

In order to get the library running correctly, the following requirements should be met:

  • You use ioBroker for all devices that you want to control or read from Make sure you got the socket.io adapter installed
  • You use devices that are supported or are able to use one of the supported devices as base for yours.
    (If you use a Zigbee or Homematic IP device that is not currently supported, don't hesitate to create a pull request and add it!)
  • You have a unix-based or windows device for the software you want to run this library with.

Build

To build the library, make sure Node.js is installed.
Then, just run npm run build.

Why would I use it?

Even if it looks simple at first, automating your entire home with a user interface can sometimes be more difficult than just coding your home.
Especially if you have a lot of specialized requirements that you want to satisfy, it can be simpler to just code your own rules and interfaces than to rely on user interfaces to do it for you.