0.1.11 • Published 6 years ago

zclip v0.1.11

Weekly downloads
1
License
ISC
Repository
-
Last release
6 years ago

ZCLIP.js

A javascript implementation of ZCL over IP.

  • Installation
  • Examples
  • API
  • Supported Clusters
  • Run the tests
  • Support

Installation

npm install zclip

Examples

Examples are located in /examples

var coap = require('coap');
var zcl = require('../.')(coap);

var deviceIp = '::1';
var clusterEndpoint = 1;

var onOff = zcl.clusters.OnOff({
  ip: deviceIp,
  endpoint: clusterEndpoint
});

onOff.on({}, (err, response) => {
  if (err) {
    console.error(err);
  }

  console.log(response.code);
});

API

  • zclip.clusters.Alarms
  • zclip.clusters.ApplianceControl
  • zclip.clusters.ApplianceEventsAndAlert
  • zclip.clusters.ApplianceIdentification
  • zclip.clusters.ApplianceStatistics
  • zclip.clusters.BallastConfiguration
  • zclip.clusters.Basic
  • zclip.clusters.BinaryInputBasic
  • zclip.clusters.ColorControl
  • zclip.clusters.Commissioning
  • zclip.clusters.DehumidificationControl
  • zclip.clusters.DeviceTemperatureConfiguration
  • zclip.clusters.Diagnostics
  • zclip.clusters.DoorLock
  • zclip.clusters.ElectricalMeasurement
  • zclip.clusters.FanControl
  • zclip.clusters.FlowMeasurement
  • zclip.clusters.Groups
  • zclip.clusters.IasAce
  • zclip.clusters.IasWd
  • zclip.clusters.IasZone
  • zclip.clusters.Identify
  • zclip.clusters.IlluminanceLevelSensing
  • zclip.clusters.IlluminanceMeasurement
  • zclip.clusters.LevelControl
  • zclip.clusters.MeterIdentification
  • zclip.clusters.OccupancySensing
  • zclip.clusters.OnOff
  • zclip.clusters.OnOffSwitchConfiguration
  • zclip.clusters.OverTheAirBootloading
  • zclip.clusters.PollControl
  • zclip.clusters.PowerConfiguration
  • zclip.clusters.PowerProfile
  • zclip.clusters.PressureMeasurement
  • zclip.clusters.PumpConfigurationAndControl
  • zclip.clusters.RelativeHumidityMeasurement
  • zclip.clusters.RssiLocation
  • zclip.clusters.Scenes
  • zclip.clusters.ShadeConfiguration
  • zclip.clusters.TemperatureMeasurement
  • zclip.clusters.Thermostat
  • zclip.clusters.ThermostatUserInterfaceConfiguration
  • zclip.clusters.Time
  • zclip.clusters.WindowCovering
  • zclip.discover
  • zclip.RD

zclip.clusters.Alarms

var alarmsCluster = zcl.clusters.Alarms({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

alarms.bind

alarmsCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

alarms.read

alarmsCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • alarmCount \ (server)
    • responseCode

alarms.alarm

alarms.alarm(args, callback);
  • args
    • alarmCode \
    • clusterId \<cluster_id>
  • callback
    • err
    • response
    • responseCode

alarms.getAlarmResponse

alarms.getAlarmResponse(args, callback);
  • args
    • status \
    • alarmCode \
    • clusterId \<cluster_id>
    • timeStamp \
  • callback
    • err
    • response
    • responseCode

alarms.getAlarm

alarms.getAlarm(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

alarms.resetAlarmLog

alarms.resetAlarmLog(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

zclip.clusters.ApplianceControl

var applianceControlCluster = zcl.clusters.ApplianceControl({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

applianceControl.bind

applianceControlCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

applianceControl.read

applianceControlCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • startTime \ (server)
      • finishTime \ (server)
      • remainingTime \ (server)
    • responseCode

applianceControl.signalStateResponse

applianceControl.signalStateResponse(args, callback);
  • args
    • applianceStatus \
    • remoteEnableFlagsAndDeviceStatus2 \
    • applianceStatus2 \
  • callback
    • err
    • response
    • responseCode

applianceControl.signalStateNotification

applianceControl.signalStateNotification(args, callback);
  • args
    • applianceStatus \
    • remoteEnableFlagsAndDeviceStatus2 \
    • applianceStatus2 \
  • callback
    • err
    • response
    • responseCode

applianceControl.writeFunctions

applianceControl.writeFunctions(args, callback);
  • args
    • functionId \
    • functionDataType \
    • functionData \
  • callback
    • err
    • response
    • responseCode

applianceControl.overloadPauseResume

applianceControl.overloadPauseResume(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

applianceControl.overloadPause

applianceControl.overloadPause(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

applianceControl.overloadWarning

applianceControl.overloadWarning(args, callback);
  • args
    • warningEvent \
  • callback
    • err
    • response
    • responseCode

zclip.clusters.ApplianceEventsAndAlert

var applianceEventsAndAlertCluster = zcl.clusters.ApplianceEventsAndAlert({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

applianceEventsAndAlert.bind

applianceEventsAndAlertCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

applianceEventsAndAlert.read

applianceEventsAndAlertCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

applianceEventsAndAlert.getAlertsResponse

applianceEventsAndAlert.getAlertsResponse(args, callback);
  • args
    • alertsCount \
    • alertStructures \
  • callback
    • err
    • response
    • responseCode

applianceEventsAndAlert.alertsNotification

applianceEventsAndAlert.alertsNotification(args, callback);
  • args
    • alertsCount \
    • alertStructures \
  • callback
    • err
    • response
    • responseCode

applianceEventsAndAlert.eventsNotification

applianceEventsAndAlert.eventsNotification(args, callback);
  • args
    • eventHeader \
    • eventId \
  • callback
    • err
    • response
    • responseCode

zclip.clusters.ApplianceIdentification

var applianceIdentificationCluster = zcl.clusters.ApplianceIdentification({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

applianceIdentification.bind

applianceIdentificationCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

applianceIdentification.read

applianceIdentificationCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • basicIdentification \ (server)
      • companyName \<char_string> (server)
      • companyId \ (server)
      • brandName \<char_string> (server)
      • brandId \ (server)
      • model \<octet_string> (server)
      • partNumber \<octet_string> (server)
      • productRevision \<octet_string> (server)
      • softwareRevision \<octet_string> (server)
      • productTypeName \<octet_string> (server)
      • productTypeId \ (server)
      • cecedSpecificationVersion \ (server)
    • responseCode

zclip.clusters.ApplianceStatistics

var applianceStatisticsCluster = zcl.clusters.ApplianceStatistics({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

applianceStatistics.bind

applianceStatisticsCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

applianceStatistics.read

applianceStatisticsCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • logMaxSize \ (server)
      • logQueueMaxSize \ (server)
    • responseCode

applianceStatistics.logRequest

applianceStatistics.logRequest(args, callback);
  • args
    • logId \
  • callback
    • err
    • response
    • responseCode

applianceStatistics.logQueueRequest

applianceStatistics.logQueueRequest(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

applianceStatistics.logQueueResponse

applianceStatistics.logQueueResponse(args, callback);
  • args
    • logQueueSize \
    • logIds \
  • callback
    • err
    • response
    • responseCode

applianceStatistics.statisticsAvailable

applianceStatistics.statisticsAvailable(args, callback);
  • args
    • logQueueSize \
    • logIds \
  • callback
    • err
    • response
    • responseCode

zclip.clusters.BallastConfiguration

var ballastConfigurationCluster = zcl.clusters.BallastConfiguration({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

ballastConfiguration.bind

ballastConfigurationCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

ballastConfiguration.read

ballastConfigurationCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • physicalMinLevel \ (server)
      • physicalMaxLevel \ (server)
      • ballastStatus \ (server)
      • minLevel \ (server)
      • maxLevel \ (server)
      • powerOnLevel \ (server)
      • powerOnFadeTime \ (server)
      • intrinsicBallastFactor \ (server)
      • ballastFactorAdjustment \ (server)
      • lampQuality \ (server)
      • lampType \<char_string> (server)
      • lampManufacturer \<char_string> (server)
      • lampRatedHours \ (server)
      • lampBurnHours \ (server)
      • lampAlarmMode \ (server)
      • lampBurnHoursTripPoint \ (server)
    • responseCode

zclip.clusters.Basic

var basicCluster = zcl.clusters.Basic({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

basic.bind

basicCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

basic.read

basicCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • zclVersion \ (server)
      • applicationVersion \ (server)
      • stackVersion \ (server)
      • hardwareVersion \ (server)
      • manufacturerName \<char_string> (server)
      • modelIdentifier \<char_string> (server)
      • dateCode \<char_string> (server)
      • powerSource \ (server)
      • genericDeviceClass \ (server)
      • genericDeviceType \ (server)
      • productCode \<octet_string> (server)
      • productUrl \<char_string> (server)
      • locationDescription \<char_string> (server)
      • physicalEnvironment \ (server)
      • deviceEnabled \ (server)
      • alarmMask \ (server)
      • disableLocalConfig \ (server)
    • responseCode

basic.resetToFactoryDefaults

basic.resetToFactoryDefaults(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

zclip.clusters.BinaryInputBasic

var binaryInputBasicCluster = zcl.clusters.BinaryInputBasic({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

binaryInputBasic.bind

binaryInputBasicCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

binaryInputBasic.read

binaryInputBasicCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • activeText \<char_string> (server)
      • description \<char_string> (server)
      • inactiveText \<char_string> (server)
      • outOfService \ (server)
      • polarity \ (server)
      • presentValue \ (server)
      • reliability \ (server)
      • statusFlags \ (server)
      • applicationType \ (server)
    • responseCode

zclip.clusters.ColorControl

var colorControlCluster = zcl.clusters.ColorControl({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

colorControl.bind

colorControlCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

colorControl.read

colorControlCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • currentHue \ (server)
      • currentSaturation \ (server)
      • remainingTime \ (server)
      • currentX \ (server)
      • currentY \ (server)
      • driftCompensation \ (server)
      • compensationText \<char_string> (server)
      • colorTemperature \ (server)
      • colorMode \ (server)
      • colorControlOptions \ (server)
      • numberOfPrimaries \ (server)
      • primary1X \ (server)
      • primary1Y \ (server)
      • primary1Intensity \ (server)
      • primary2X \ (server)
      • primary2Y \ (server)
      • primary2Intensity \ (server)
      • primary3X \ (server)
      • primary3Y \ (server)
      • primary3Intensity \ (server)
      • primary4X \ (server)
      • primary4Y \ (server)
      • primary4Intensity \ (server)
      • primary5X \ (server)
      • primary5Y \ (server)
      • primary5Intensity \ (server)
      • primary6X \ (server)
      • primary6Y \ (server)
      • primary6Intensity \ (server)
      • whitePointX \ (server)
      • whitePointY \ (server)
      • colorPointRX \ (server)
      • colorPointRY \ (server)
      • colorPointRIntensity \ (server)
      • colorPointGX \ (server)
      • colorPointGY \ (server)
      • colorPointGIntensity \ (server)
      • colorPointBX \ (server)
      • colorPointBY \ (server)
      • colorPointBIntensity \ (server)
      • coupleColorTempToLevelMinMireds \ (server)
      • startUpColorTemperatureMireds \ (server)
    • responseCode

colorControl.moveToColorTemperature

colorControl.moveToColorTemperature(args, callback);
  • args
    • colorTemperature \
    • transitionTime \
  • callback
    • err
    • response
    • responseCode

colorControl.moveHue

colorControl.moveHue(args, callback);
  • args
    • moveMode \
    • rate \
  • callback
    • err
    • response
    • responseCode

colorControl.stepHue

colorControl.stepHue(args, callback);
  • args
    • stepMode \
    • stepSize \
    • transitionTime \
  • callback
    • err
    • response
    • responseCode

colorControl.moveToSaturation

colorControl.moveToSaturation(args, callback);
  • args
    • saturation \
    • transitionTime \
  • callback
    • err
    • response
    • responseCode

colorControl.moveSaturation

colorControl.moveSaturation(args, callback);
  • args
    • moveMode \
    • rate \
  • callback
    • err
    • response
    • responseCode

colorControl.stepSaturation

colorControl.stepSaturation(args, callback);
  • args
    • stepMode \
    • stepSize \
    • transitionTime \
  • callback
    • err
    • response
    • responseCode

colorControl.moveToHueAndSaturation

colorControl.moveToHueAndSaturation(args, callback);
  • args
    • hue \
    • saturation \
    • transitionTime \
  • callback
    • err
    • response
    • responseCode

colorControl.moveToColor

colorControl.moveToColor(args, callback);
  • args
    • colorx \
    • colory \
    • transitionTime \
  • callback
    • err
    • response
    • responseCode

colorControl.moveColor

colorControl.moveColor(args, callback);
  • args
    • ratex \
    • ratey \
  • callback
    • err
    • response
    • responseCode

colorControl.stepColor

colorControl.stepColor(args, callback);
  • args
    • stepx \
    • stepy \
    • transitionTime \
  • callback
    • err
    • response
    • responseCode

zclip.clusters.Commissioning

var commissioningCluster = zcl.clusters.Commissioning({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

commissioning.bind

commissioningCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

commissioning.read

commissioningCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • shortAddress \ (server)
      • extendedPanId \<ieee_address> (server)
      • panId \ (server)
      • channelMask \ (server)
      • protocolVersion \ (server)
      • stackProfile \ (server)
      • startupControl \ (server)
      • trustCenterAddress \<ieee_address> (server)
      • trustCenterMasterKey \<security_key> (server)
      • networkKey \<security_key> (server)
      • useInsecureJoin \ (server)
      • preconfiguredLinkKey \<security_key> (server)
      • networkKeySequenceNumber \ (server)
      • networkKeyType \ (server)
      • networkManagerAddress \ (server)
      • scanAttempts \ (server)
      • timeBetweenScans \ (server)
      • rejoinInterval \ (server)
      • maxRejoinInterval \ (server)
      • indirectPollRate \ (server)
      • parentRetryThreshold \ (server)
      • concentratorFlag \ (server)
      • concentratorRadius \ (server)
      • concentratorDiscoveryTime \ (server)
    • responseCode

commissioning.restartDeviceResponse

commissioning.restartDeviceResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

commissioning.saveStartupParametersResponse

commissioning.saveStartupParametersResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

commissioning.restoreStartupParametersResponse

commissioning.restoreStartupParametersResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

commissioning.resetStartupParametersResponse

commissioning.resetStartupParametersResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

zclip.clusters.DehumidificationControl

var dehumidificationControlCluster = zcl.clusters.DehumidificationControl({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

dehumidificationControl.bind

dehumidificationControlCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

dehumidificationControl.read

dehumidificationControlCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • relativeHumidity \ (server)
      • dehumidificationCooling \ (server)
      • rhDehumidificationSetpoint \ (server)
      • relativeHumidityMode \ (server)
      • dehumidificationLockout \ (server)
      • dehumidificationHysteresis \ (server)
      • dehumidificationMaxCool \ (server)
      • relativeHumidityDisplay \ (server)
    • responseCode

zclip.clusters.DeviceTemperatureConfiguration

var deviceTemperatureConfigurationCluster = zcl.clusters.DeviceTemperatureConfiguration({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

deviceTemperatureConfiguration.bind

deviceTemperatureConfigurationCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

deviceTemperatureConfiguration.read

deviceTemperatureConfigurationCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • currentTemperature \ (server)
      • minTempExperienced \ (server)
      • maxTempExperienced \ (server)
      • overTempTotalDwell \ (server)
      • deviceTempAlarmMask \ (server)
      • lowTempThreshold \ (server)
      • highTempThreshold \ (server)
      • lowTempDwellTripPoint \ (server)
      • highTempDwellTripPoint \ (server)
    • responseCode

zclip.clusters.Diagnostics

var diagnosticsCluster = zcl.clusters.Diagnostics({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

diagnostics.bind

diagnosticsCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

diagnostics.read

diagnosticsCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • numberOfResets \ (server)
      • persistentMemoryWrites \ (server)
      • macRxBroadcast \ (server)
      • macTxBroadcast \ (server)
      • macRxUnicast \ (server)
      • macTxUnicast \ (server)
      • macTxUnicastRetry \ (server)
      • macTxUnicastFail \ (server)
      • apsRxBroadcast \ (server)
      • apsTxBroadcast \ (server)
      • apsRxUnicast \ (server)
      • apsUnicastSuccess \ (server)
      • apsTxUnicastRetries \ (server)
      • apsTxUnicastFailures \ (server)
      • routeDiscoveryInitiated \ (server)
      • neighborAdded \ (server)
      • neighborMoved \ (server)
      • neighborStale \ (server)
      • joinIndication \ (server)
      • childMoved \ (server)
      • networkFrameControlFailure \ (server)
      • apsFrameControlFailure \ (server)
      • apsUnauthorizedKey \ (server)
      • networkDecryptionFailure \ (server)
      • apsDecryptionFailure \ (server)
      • packetBufferAllocationFailures \ (server)
      • relayedUnicasts \ (server)
      • phyToMacQueueLimitReached \ (server)
      • packetValidateDropCount \ (server)
      • averageMacRetryPerApsMessageSent \ (server)
      • lastMessageLqi \ (server)
      • lastMessageRssi \ (server)
    • responseCode

zclip.clusters.DoorLock

var doorLockCluster = zcl.clusters.DoorLock({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

doorLock.bind

doorLockCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

doorLock.read

doorLockCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • lockState \ (server)
      • lockType \ (server)
      • actuatorEnabled \ (server)
      • doorState \ (server)
      • doorOpenEvents \ (server)
      • doorClosedEvents \ (server)
      • openPeriod \ (server)
      • numLockRecordsSupported \ (server)
      • numTotalUsersSupported \ (server)
      • numPinUsersSupported \ (server)
      • numRfidUsersSupported \ (server)
      • numWeekdaySchedulesSupportedPerUser \ (server)
      • numYeardaySchedulesSupportedPerUser \ (server)
      • numHolidaySchedulesSupportedPerUser \ (server)
      • maxPinLength \ (server)
      • minPinLength \ (server)
      • maxRfidCodeLength \ (server)
      • minRfidCodeLength \ (server)
      • enableLogging \ (server)
      • language \<char_string> (server)
      • ledSettings \ (server)
      • autoRelockTime \ (server)
      • soundVolume \ (server)
      • operatingMode \ (server)
      • supportedOperatingModes \ (server)
      • defaultConfigurationRegister \ (server)
      • enableLocalProgramming \ (server)
      • enableOneTouchLocking \ (server)
      • enableInsideStatusLed \ (server)
      • enablePrivacyModeButton \ (server)
      • wrongCodeEntryLimit \ (server)
      • userCodeTemporaryDisableTime \ (server)
      • sendPinOverTheAir \ (server)
      • requirePinForRfOperation \ (server)
      • zigbeeSecurityLevel \ (server)
      • alarmMask \ (server)
      • keypadOperationEventMask \ (server)
      • rfOperationEventMask \ (server)
      • manualOperationEventMask \ (server)
      • rfidOperationEventMask \ (server)
      • keypadProgrammingEventMask \ (server)
      • rfProgrammingEventMask \ (server)
      • rfidProgrammingEventMask \ (server)
    • responseCode

doorLock.getYeardayScheduleResponse

doorLock.getYeardayScheduleResponse(args, callback);
  • args
    • scheduleId \
    • userId \
    • status \
    • localStartTime \
    • localEndTime \
  • callback
    • err
    • response
    • responseCode

doorLock.unlockDoorResponse

doorLock.unlockDoorResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

doorLock.toggleResponse

doorLock.toggleResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

doorLock.unlockWithTimeoutResponse

doorLock.unlockWithTimeoutResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

doorLock.getLogRecordResponse

doorLock.getLogRecordResponse(args, callback);
  • args
    • logEntryId \
    • timestamp \
    • eventType \
    • source \
    • eventIdOrAlarmCode \
    • userId \
    • pin \<char_string>
  • callback
    • err
    • response
    • responseCode

doorLock.setPinResponse

doorLock.setPinResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

doorLock.getPinResponse

doorLock.getPinResponse(args, callback);
  • args
    • userId \
    • userStatus \
    • userType \
    • pin \<char_string>
  • callback
    • err
    • response
    • responseCode

doorLock.clearPinResponse

doorLock.clearPinResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

doorLock.clearAllPinsResponse

doorLock.clearAllPinsResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

doorLock.setUserStatusResponse

doorLock.setUserStatusResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

doorLock.clearYeardayScheduleResponse

doorLock.clearYeardayScheduleResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

doorLock.setHolidayScheduleResponse

doorLock.setHolidayScheduleResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

doorLock.getHolidayScheduleResponse

doorLock.getHolidayScheduleResponse(args, callback);
  • args
    • scheduleId \
    • status \
    • localStartTime \
    • localEndTime \
    • operatingModeDuringHoliday \
  • callback
    • err
    • response
    • responseCode

doorLock.clearHolidayScheduleResponse

doorLock.clearHolidayScheduleResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

doorLock.setUserTypeResponse

doorLock.setUserTypeResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

doorLock.getUserTypeResponse

doorLock.getUserTypeResponse(args, callback);
  • args
    • userId \
    • userType \
  • callback
    • err
    • response
    • responseCode

doorLock.setRfidResponse

doorLock.setRfidResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

doorLock.getRfidResponse

doorLock.getRfidResponse(args, callback);
  • args
    • userId \
    • userStatus \
    • userType \
    • rfid \<char_string>
  • callback
    • err
    • response
    • responseCode

doorLock.clearRfidResponse

doorLock.clearRfidResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

doorLock.clearAllRfidsResponse

doorLock.clearAllRfidsResponse(args, callback);
  • args
    • status \
  • callback
    • err
    • response
    • responseCode

doorLock.operationEventNotification

doorLock.operationEventNotification(args, callback);
  • args
    • source \
    • eventCode \
    • userId \
    • pin \<char_string>
    • timeStamp \
    • data \<char_string>
  • callback
    • err
    • response
    • responseCode

doorLock.programmingEventNotification

doorLock.programmingEventNotification(args, callback);
  • args
    • source \
    • eventCode \
    • userId \
    • pin \<char_string>
    • userType \
    • userStatus \
    • timeStamp \
    • data \<char_string>
  • callback
    • err
    • response
    • responseCode

zclip.clusters.ElectricalMeasurement

var electricalMeasurementCluster = zcl.clusters.ElectricalMeasurement({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

electricalMeasurement.bind

electricalMeasurementCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

electricalMeasurement.read

electricalMeasurementCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • measurementType \ (server)
      • dcVoltage \ (server)
      • dcVoltageMin \ (server)
      • dcVoltageMax \ (server)
      • dcCurrent \ (server)
      • dcCurrentMin \ (server)
      • dcCurrentMax \ (server)
      • dcPower \ (server)
      • dcPowerMin \ (server)
      • dcPowerMax \ (server)
      • dcVoltageMultiplier \ (server)
      • dcVoltageDivisor \ (server)
      • dcCurrentMultiplier \ (server)
      • dcCurrentDivisor \ (server)
      • dcPowerMultiplier \ (server)
      • dcPowerDivisor \ (server)
      • acFrequency \ (server)
      • acFrequencyMin \ (server)
      • acFrequencyMax \ (server)
      • neutralCurrent \ (server)
      • totalActivePower \ (server)
      • totalReactivePower \ (server)
      • totalApparentPower \ (server)
      • measured1stHarmonicCurrent \ (server)
      • measured3rdHarmonicCurrent \ (server)
      • measured5thHarmonicCurrent \ (server)
      • measured7thHarmonicCurrent \ (server)
      • measured9thHarmonicCurrent \ (server)
      • measured11thHarmonicCurrent \ (server)
      • measuredPhase1stHarmonicCurrent \ (server)
      • measuredPhase3rdHarmonicCurrent \ (server)
      • measuredPhase5thHarmonicCurrent \ (server)
      • measuredPhase7thHarmonicCurrent \ (server)
      • measuredPhase9thHarmonicCurrent \ (server)
      • measuredPhase11thHarmonicCurrent \ (server)
      • acFrequencyMultiplier \ (server)
      • acFrequencyDivisor \ (server)
      • powerMultiplier \ (server)
      • powerDivisor \ (server)
      • harmonicCurrentMultiplier \ (server)
      • phaseHarmonicCurrentMultiplier \ (server)
      • instantaneousVoltage \ (server)
      • instantaneousLineCurrent \ (server)
      • instantaneousActiveCurrent \ (server)
      • instantaneousReactiveCurrent \ (server)
      • instantaneousPower \ (server)
      • rmsVoltage \ (server)
      • rmsVoltageMin \ (server)
      • rmsVoltageMax \ (server)
      • rmsCurrent \ (server)
      • rmsCurrentMin \ (server)
      • rmsCurrentMax \ (server)
      • activePower \ (server)
      • activePowerMin \ (server)
      • activePowerMax \ (server)
      • reactivePower \ (server)
      • apparentPower \ (server)
      • powerFactor \ (server)
      • averageRmsVoltageMeasurementPeriod \ (server)
      • averageRmsUnderVoltageCounter \ (server)
      • rmsExtremeOverVoltagePeriod \ (server)
      • rmsExtremeUnderVoltagePeriod \ (server)
      • rmsVoltageSagPeriod \ (server)
      • rmsVoltageSwellPeriod \ (server)
      • acVoltageMultiplier \ (server)
      • acVoltageDivisor \ (server)
      • acCurrentMultiplier \ (server)
      • acCurrentDivisor \ (server)
      • acPowerMultiplier \ (server)
      • acPowerDivisor \ (server)
      • overloadAlarmsMask \ (server)
      • voltageOverload \ (server)
      • currentOverload \ (server)
      • acOverloadAlarmsMask \ (server)
      • acVoltageOverload \ (server)
      • acCurrentOverload \ (server)
      • acActivePowerOverload \ (server)
      • acReactivePowerOverload \ (server)
      • averageRmsOverVoltage \ (server)
      • averageRmsUnderVoltage \ (server)
      • rmsExtremeOverVoltage \ (server)
      • rmsExtremeUnderVoltage \ (server)
      • rmsVoltageSag \ (server)
      • rmsVoltageSwell \ (server)
      • lineCurrentPhaseB \ (server)
      • activeCurrentPhaseB \ (server)
      • reactiveCurrentPhaseB \ (server)
      • rmsVoltagePhaseB \ (server)
      • rmsVoltageMinPhaseB \ (server)
      • rmsVoltageMaxPhaseB \ (server)
      • rmsCurrentPhaseB \ (server)
      • rmsCurrentMinPhaseB \ (server)
      • rmsCurrentMaxPhaseB \ (server)
      • activePowerPhaseB \ (server)
      • activePowerMinPhaseB \ (server)
      • activePowerMaxPhaseB \ (server)
      • reactivePowerPhaseB \ (server)
      • apparentPowerPhaseB \ (server)
      • powerFactorPhaseB \ (server)
      • averageRmsVoltageMeasurementPeriodPhaseB \ (server)
      • averageRmsOverVoltageCounterPhaseB \ (server)
      • averageRmsUnderVoltageCounterPhaseB \ (server)
      • rmsExtremeOverVoltagePeriodPhaseB \ (server)
      • rmsExtremeUnderVoltagePeriodPhaseB \ (server)
      • rmsVoltageSagPeriodPhaseB \ (server)
      • rmsVoltageSwellPeriodPhaseB \ (server)
      • lineCurrentPhaseC \ (server)
      • activeCurrentPhaseC \ (server)
      • reactiveCurrentPhaseC \ (server)
      • rmsVoltagePhaseC \ (server)
      • rmsVoltageMinPhaseC \ (server)
      • rmsVoltageMaxPhaseC \ (server)
      • rmsCurrentPhaseB \ (server)
      • rmsCurrentMinPhaseC \ (server)
      • rmsCurrentMaxPhaseC \ (server)
      • activePowerPhaseC \ (server)
      • activePowerMinPhaseC \ (server)
      • activePowerMaxPhaseC \ (server)
      • reactivePowerPhaseC \ (server)
      • apparentPowerPhaseC \ (server)
      • powerFactorPhaseC \ (server)
      • averageRmsVoltageMeasurementPeriodPhaseC \ (server)
      • averageRmsOverVoltageCounterPhaseC \ (server)
      • averageRmsUnderVoltageCounterPhaseC \ (server)
      • rmsExtremeOverVoltagePeriodPhaseC \ (server)
      • rmsExtremeUnderVoltagePeriodPhaseC \ (server)
      • rmsVoltageSagPeriodPhaseC \ (server)
      • rmsVoltageSwellPeriodPhaseC \ (server)
    • responseCode

electricalMeasurement.getProfileInfoCommand

electricalMeasurement.getProfileInfoCommand(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

electricalMeasurement.getMeasurementProfileCommand

electricalMeasurement.getMeasurementProfileCommand(args, callback);
  • args
    • attributeId \
    • startTime \
    • numberOfIntervals \
  • callback
    • err
    • response
    • responseCode

zclip.clusters.FanControl

var fanControlCluster = zcl.clusters.FanControl({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

fanControl.bind

fanControlCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

fanControl.read

fanControlCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • fanMode \ (server)
      • fanModeSequence \ (server)
    • responseCode

zclip.clusters.FlowMeasurement

var flowMeasurementCluster = zcl.clusters.FlowMeasurement({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

flowMeasurement.bind

flowMeasurementCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

flowMeasurement.read

flowMeasurementCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • measuredValue \ (server)
      • minMeasuredValue \ (server)
      • maxMeasuredValue \ (server)
      • tolerance \ (server)
    • responseCode

zclip.clusters.Groups

var groupsCluster = zcl.clusters.Groups({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

groups.bind

groupsCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

groups.read

groupsCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • nameSupport \ (server)
    • responseCode

groups.addGroupResponse

groups.addGroupResponse(args, callback);
  • args
    • status \
    • groupId \
  • callback
    • err
    • response
    • responseCode

groups.viewGroupResponse

groups.viewGroupResponse(args, callback);
  • args
    • status \
    • groupId \
    • groupName \<char_string>
  • callback
    • err
    • response
    • responseCode

groups.getGroupMembershipResponse

groups.getGroupMembershipResponse(args, callback);
  • args
    • capacity \
    • groupCount \
    • groupList \
  • callback
    • err
    • response
    • responseCode

groups.removeGroupResponse

groups.removeGroupResponse(args, callback);
  • args
    • status \
    • groupId \
  • callback
    • err
    • response
    • responseCode

groups.removeAllGroups

groups.removeAllGroups(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

groups.addGroupIfIdentifying

groups.addGroupIfIdentifying(args, callback);
  • args
    • groupId \
    • groupName \<char_string>
  • callback
    • err
    • response
    • responseCode

zclip.clusters.IasAce

var iasAceCluster = zcl.clusters.IasAce({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

iasAce.bind

iasAceCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

iasAce.read

iasAceCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

iasAce.armResponse

iasAce.armResponse(args, callback);
  • args
    • armNotification \
  • callback
    • err
    • response
    • responseCode

iasAce.getZoneIdMapResponse

iasAce.getZoneIdMapResponse(args, callback);
  • args
    • section0 \
    • section1 \
    • section2 \
    • section3 \
    • section4 \
    • section5 \
    • section6 \
    • section7 \
    • section8 \
    • section9 \
    • section10 \
    • section11 \
    • section12 \
    • section13 \
    • section14 \
    • section15 \
  • callback
    • err
    • response
    • responseCode

iasAce.getZoneInformationResponse

iasAce.getZoneInformationResponse(args, callback);
  • args
    • zoneId \
    • zoneType \
    • ieeeAddress \<ieee_address>
    • zoneLabel \<char_string>
  • callback
    • err
    • response
    • responseCode

iasAce.zoneStatusChanged

iasAce.zoneStatusChanged(args, callback);
  • args
    • zoneId \
    • zoneStatus \
    • audibleNotification \
    • zoneLabel \<char_string>
  • callback
    • err
    • response
    • responseCode

iasAce.panelStatusChanged

iasAce.panelStatusChanged(args, callback);
  • args
    • panelStatus \
    • secondsRemaining \
    • audibleNotification \
    • alarmStatus \
  • callback
    • err
    • response
    • responseCode

iasAce.getPanelStatusResponse

iasAce.getPanelStatusResponse(args, callback);
  • args
    • panelStatus \
    • secondsRemaining \
    • audibleNotification \
    • alarmStatus \
  • callback
    • err
    • response
    • responseCode

iasAce.setBypassedZoneList

iasAce.setBypassedZoneList(args, callback);
  • args
    • numberOfZones \
    • zoneIds \
  • callback
    • err
    • response
    • responseCode

iasAce.bypassResponse

iasAce.bypassResponse(args, callback);
  • args
    • numberOfZones \
    • bypassResult \
  • callback
    • err
    • response
    • responseCode

iasAce.getZoneStatusResponse

iasAce.getZoneStatusResponse(args, callback);
  • args
    • zoneStatusComplete \
    • numberOfZones \
    • zoneStatusResult \
  • callback
    • err
    • response
    • responseCode

iasAce.getZoneStatus

iasAce.getZoneStatus(args, callback);
  • args
    • startingZoneId \
    • maxNumberOfZoneIds \
    • zoneStatusMaskFlag \
    • zoneStatusMask \
  • callback
    • err
    • response
    • responseCode

zclip.clusters.IasWd

var iasWdCluster = zcl.clusters.IasWd({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

iasWd.bind

iasWdCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

iasWd.read

iasWdCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • maxDuration \ (server)
    • responseCode

iasWd.startWarning

iasWd.startWarning(args, callback);
  • args
    • warningInfo \
    • warningDuration \
    • strobeDutyCycle \
    • strobeLevel \
  • callback
    • err
    • response
    • responseCode

iasWd.squawk

iasWd.squawk(args, callback);
  • args
    • squawkInfo \
  • callback
    • err
    • response
    • responseCode

zclip.clusters.IasZone

var iasZoneCluster = zcl.clusters.IasZone({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

iasZone.bind

iasZoneCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

iasZone.read

iasZoneCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • zoneState \ (server)
      • zoneType \ (server)
      • zoneStatus \ (server)
      • iasCieAddress \<ieee_address> (server)
      • zoneId \ (server)
      • numberOfZoneSensitivityLevelsSupported \ (server)
      • currentZoneSensitivityLevel \ (server)
    • responseCode

iasZone.zoneStatusChangeNotification

iasZone.zoneStatusChangeNotification(args, callback);
  • args
    • zoneStatus \
    • extendedStatus \
    • zoneId \
    • delay \
  • callback
    • err
    • response
    • responseCode

iasZone.zoneEnrollRequest

iasZone.zoneEnrollRequest(args, callback);
  • args
    • zoneType \
    • manufacturerCode \
  • callback
    • err
    • response
    • responseCode

iasZone.initiateNormalOperationModeResponse

iasZone.initiateNormalOperationModeResponse(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

iasZone.initiateTestModeResponse

iasZone.initiateTestModeResponse(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

zclip.clusters.Identify

var identifyCluster = zcl.clusters.Identify({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

identify.bind

identifyCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

identify.read

identifyCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • identifyTime \ (server)
      • commissionState \ (server)
    • responseCode

identify.identifyQueryResponse

identify.identifyQueryResponse(args, callback);
  • args
    • timeout \
  • callback
    • err
    • response
    • responseCode

identify.identifyQuery

identify.identifyQuery(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

identify.ezModeInvoke

identify.ezModeInvoke(args, callback);
  • args
    • action \
  • callback
    • err
    • response
    • responseCode

identify.updateCommissionState

identify.updateCommissionState(args, callback);
  • args
    • action \
    • commissionStateMask \
  • callback
    • err
    • response
    • responseCode

zclip.clusters.IlluminanceLevelSensing

var illuminanceLevelSensingCluster = zcl.clusters.IlluminanceLevelSensing({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

illuminanceLevelSensing.bind

illuminanceLevelSensingCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

illuminanceLevelSensing.read

illuminanceLevelSensingCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • levelStatus \ (server)
      • lightSensorType \ (server)
      • illuminanceLevelTarget \ (server)
    • responseCode

zclip.clusters.IlluminanceMeasurement

var illuminanceMeasurementCluster = zcl.clusters.IlluminanceMeasurement({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

illuminanceMeasurement.bind

illuminanceMeasurementCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

illuminanceMeasurement.read

illuminanceMeasurementCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • measuredValue \ (server)
      • minMeasuredValue \ (server)
      • maxMeasuredValue \ (server)
      • tolerance \ (server)
      • lightSensorType \ (server)
    • responseCode

zclip.clusters.LevelControl

var levelControlCluster = zcl.clusters.LevelControl({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

levelControl.bind

levelControlCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

levelControl.read

levelControlCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • currentLevel \ (server)
      • remainingTime \ (server)
      • options \ (server)
      • onOffTransitionTime \ (server)
      • onLevel \ (server)
      • onTransitionTime \ (server)
      • offTransitionTime \ (server)
      • defaultMoveRate \ (server)
      • startUpCurrentLevel \ (server)
    • responseCode

levelControl.moveToLevel

levelControl.moveToLevel(args, callback);
  • args
    • level \
    • transitionTime \
  • callback
    • err
    • response
    • responseCode

levelControl.move

levelControl.move(args, callback);
  • args
    • moveMode \
    • rate \
  • callback
    • err
    • response
    • responseCode

levelControl.step

levelControl.step(args, callback);
  • args
    • stepMode \
    • stepSize \
    • transitionTime \
  • callback
    • err
    • response
    • responseCode

levelControl.stop

levelControl.stop(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

levelControl.moveToLevelWithOnOff

levelControl.moveToLevelWithOnOff(args, callback);
  • args
    • level \
    • transitionTime \
  • callback
    • err
    • response
    • responseCode

levelControl.moveWithOnOff

levelControl.moveWithOnOff(args, callback);
  • args
    • moveMode \
    • rate \
  • callback
    • err
    • response
    • responseCode

levelControl.stepWithOnOff

levelControl.stepWithOnOff(args, callback);
  • args
    • stepMode \
    • stepSize \
    • transitionTime \
  • callback
    • err
    • response
    • responseCode

levelControl.stopWithOnOff

levelControl.stopWithOnOff(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

zclip.clusters.MeterIdentification

var meterIdentificationCluster = zcl.clusters.MeterIdentification({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

meterIdentification.bind

meterIdentificationCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

meterIdentification.read

meterIdentificationCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • companyName \<char_string> (server)
      • meterTypeId \ (server)
      • dataQualityId \ (server)
      • customerName \<char_string> (server)
      • model \<octet_string> (server)
      • partNumber \<octet_string> (server)
      • productRevision \<octet_string> (server)
      • softwareRevision \<octet_string> (server)
      • utilityName \<char_string> (server)
      • pod \<char_string> (server)
      • availablePower \ (server)
      • powerThreshold \ (server)
    • responseCode

zclip.clusters.OccupancySensing

var occupancySensingCluster = zcl.clusters.OccupancySensing({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

occupancySensing.bind

occupancySensingCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

occupancySensing.read

occupancySensingCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • occupancy \ (server)
      • occupancySensorType \ (server)
      • pirOccupiedToUnoccupiedDelay \ (server)
      • pirUnoccupiedToOccupiedDelay \ (server)
      • pirUnoccupiedToOccupiedThreshold \ (server)
      • ultrasonicOccupiedToUnoccupiedDelay \ (server)
      • ultrasonicUnoccupiedToOccupiedDelay \ (server)
      • ultrasonicUnoccupiedToOccupiedThreshold \ (server)
    • responseCode

zclip.clusters.OnOff

var onOffCluster = zcl.clusters.OnOff({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

onOff.bind

onOffCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

onOff.read

onOffCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • onOff \ (server)
      • startUpOnOff \ (server)
    • responseCode

onOff.off

onOff.off(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

onOff.on

onOff.on(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

onOff.toggle

onOff.toggle(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

zclip.clusters.OnOffSwitchConfiguration

var onOffSwitchConfigurationCluster = zcl.clusters.OnOffSwitchConfiguration({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

onOffSwitchConfiguration.bind

onOffSwitchConfigurationCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

onOffSwitchConfiguration.read

onOffSwitchConfigurationCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • switchType \ (server)
      • switchActions \ (server)
    • responseCode

zclip.clusters.OverTheAirBootloading

var overTheAirBootloadingCluster = zcl.clusters.OverTheAirBootloading({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

overTheAirBootloading.bind

overTheAirBootloadingCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

overTheAirBootloading.read

overTheAirBootloadingCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • otaUpgradeServerId \<ieee_address> (client)
      • offsetAddressIntoTheFile \ (client)
      • otaCurrentFileVersion \ (client)
      • otaCurrentZigBeeStackVersion \ (client)
      • otaDownloadedFileVersion \ (client)
      • otaDownloadedZigBeeStackVersion \ (client)
      • otaUpgradeStatus \ (client)
      • manufacturerId \ (client)
      • imageTypeId \ (client)
      • minimumBlockRequestPeriod \ (client)
      • imageStamp \ (client)
      • upgradeActivationPolicy \ (client)
      • upgradeTimeoutPolicy \ (client)
    • responseCode

overTheAirBootloading.imageNotify

overTheAirBootloading.imageNotify(args, callback);
  • args
    • payloadType \
    • queryJitter \
    • manufacturerId \
    • imageType \
    • newFileVersion \
  • callback
    • err
    • response
    • responseCode

overTheAirBootloading.queryNextImageRequest

overTheAirBootloading.queryNextImageRequest(args, callback);
  • args
    • fieldControl \
    • manufacturerId \
    • imageType \
    • currentFileVersion \
    • hardwareVersion \
  • callback
    • err
    • response
    • responseCode

overTheAirBootloading.queryNextImageResponse

overTheAirBootloading.queryNextImageResponse(args, callback);
  • args
    • status \
    • manufacturerId \
    • imageType \
    • fileVersion \
    • imageSize \
  • callback
    • err
    • response
    • responseCode

overTheAirBootloading.imageBlockRequest

overTheAirBootloading.imageBlockRequest(args, callback);
  • args
    • fieldControl \
    • manufacturerId \
    • imageType \
    • fileVersion \
    • fileOffset \
    • maxDataSize \
    • requestNodeAddress \<ieee_address>
  • callback
    • err
    • response
    • responseCode

overTheAirBootloading.imagePageRequest

overTheAirBootloading.imagePageRequest(args, callback);
  • args
    • fieldControl \
    • manufacturerId \
    • imageType \
    • fileVersion \
    • fileOffset \
    • maxDataSize \
    • pageSize \
    • responseSpacing \
    • requestNodeAddress \<ieee_address>
  • callback
    • err
    • response
    • responseCode

overTheAirBootloading.imageBlockResponse

overTheAirBootloading.imageBlockResponse(args, callback);
  • args
    • status \
    • manufacturerId \
    • imageType \
    • fileVersion \
    • fileOffset \
    • dataSize \
    • imageData \
  • callback
    • err
    • response
    • responseCode

overTheAirBootloading.upgradeEndRequest

overTheAirBootloading.upgradeEndRequest(args, callback);
  • args
    • status \
    • manufacturerId \
    • imageType \
    • fileVersion \
  • callback
    • err
    • response
    • responseCode

overTheAirBootloading.upgradeEndResponse

overTheAirBootloading.upgradeEndResponse(args, callback);
  • args
    • manufacturerId \
    • imageType \
    • fileVersion \
    • currentTime \<utc_time>
    • upgradeTime \<utc_time>
  • callback
    • err
    • response
    • responseCode

overTheAirBootloading.querySpecificFileRequest

overTheAirBootloading.querySpecificFileRequest(args, callback);
  • args
    • requestNodeAddress \<ieee_address>
    • manufacturerId \
    • imageType \
    • fileVersion \
    • currentZigbeeStackVersion \
  • callback
    • err
    • response
    • responseCode

overTheAirBootloading.querySpecificFileResponse

overTheAirBootloading.querySpecificFileResponse(args, callback);
  • args
    • status \
    • manufacturerId \
    • imageType \
    • fileVersion \
    • imageSize \
  • callback
    • err
    • response
    • responseCode

zclip.clusters.PollControl

var pollControlCluster = zcl.clusters.PollControl({
  ip: <deviceIp>,
  endpoint: <clusterEndpoint>
});

pollControl.bind

pollControlCluster.bind(args, callback);
  • args
    • uid
    • ip
    • port
    • endpoint
  • callback
    • err
    • response
    • responseCode

pollControl.read

pollControlCluster.read(args, callback);
  • args - None
  • callback
    • err
    • response
      • checkInInterval \ (server)
      • longPollInterval \ (server)
      • shortPollInterval \ (server)
      • fastPollTimeout \ (server)
      • checkInIntervalMin \ (server)
      • longPollIntervalMin \ (server)
      • fastPollTimeoutMax \ (server)
    • responseCode

pollControl.checkInResponse

pollControl.checkInResponse(args, callback);
  • args
    • startFastPolling \
    • fastPollTimeout \
  • callback
    • err
    • response
    • responseCode

pollControl.fastPollStop

pollControl.fastPollStop(args, callback);
  • args - None
  • callback
    • err
    • response
    • responseCode

pollControl.setLongPollInterval

pollControl.setLongPollInterval(args, callback);
  • args
    • newLongPollIn
base64urlcbor
@infinitebrahmanuniverse/nolb-zc@everything-registry/sub-chunk-3223zclip-cli
0.1.11

6 years ago

0.1.10

6 years ago

0.1.9

6 years ago

0.1.8

6 years ago

0.1.7

6 years ago

0.1.6

6 years ago

0.1.5

6 years ago

0.1.4

6 years ago

0.1.3

6 years ago

0.1.2

6 years ago

0.1.1

7 years ago