Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DirectionalDevice

Z-Bus directional device which controls the motion of blinds, windows, or awnings

Hierarchy

  • DirectionalDevice

Implements

Index

Constructors

constructor

  • Creates a new Z-Bus DirectionalDevice

    Example

    { DirectionalDevice } = require('@z-bus/api');
    //Moves address 0 up
    new DirectionalDevice(0).up();
    

    Parameters

    • address: number

      Address between 0 and 242 to which the device will be linked

    Returns DirectionalDevice

Properties

address

address: number[]

Addresses the Z-Bus device is linked to. The device will react when receiving a corresponding DeviceEvent and change its state accordingly.

Optional id

id: string

Unique id that identifies the Z-Bus device in the database

Optional memory

memory: "up" | "down" | "stop"

Optional name

name: string

Display name of the Z-Bus device

Optional profile

profile: string

Display profile for the Z-Bus device (determines state descriptions and symbols), e.g.:

  • a lamp
  • a heating,
  • ...

Optional state

state: "up" | "down" | "stop"

Current state the Z-Bus device is in, e.g.:

  • 'undefined'
  • 'on'
  • 'off'
  • 'up'
  • 'down'
  • 'stop'

type

type: DeviceType = 'directional'

Identifies the different types of Z-Bus devices:

Static Machine

Machine: MachineDefinition = ...

Static Profiles

Profiles: { description: string; profile: string; states: { description: string; state: string }[]; transitions: { description: string; transition: string }[] }[] = ...

Static description

description: string = 'Motor-Schaltempfänger (Jalousie, Rollladen, Fenster, ...)'

Methods

down

  • down(): void

down_stop

  • down_stop(): void
  • Steps a DirectionalDevice. The device will alternate

    • from moving 'down' to 'stop', or
    • from 'stop' to moving 'down'

    Returns void

stop

  • stop(): void

transmit

  • transmit(command: number | "toggle" | "up-stop" | "down-stop" | "start" | "end" | "on" | "off" | "up" | "down" | "stop"): void
  • Controls the Z-Bus DirectionalDevice

    Parameters

    • command: number | "toggle" | "up-stop" | "down-stop" | "start" | "end" | "on" | "off" | "up" | "down" | "stop"

      Command used to control the device between 0 and 255 (values see Command)

    Returns void

up

  • up(): void

up_stop

  • up_stop(): void
  • Steps a DirectionalDevice. The device will alternate

    • from moving 'up' to 'stop', or
    • from 'stop' to moving 'up'

    Returns void

Generated using TypeDoc