constants.cs

来自「zwave 无线通讯协议 PC controller 控制器源码」· CS 代码 · 共 559 行 · 第 1/2 页

//////////////////////////////////////////////////////////////////////////////////////////////// 
//
//          #######
//          #   ##    ####   #####    #####  ##  ##   #####
//             ##    ##  ##  ##  ##  ##      ##  ##  ##
//            ##  #  ######  ##  ##   ####   ##  ##   ####
//           ##  ##  ##      ##  ##      ##   #####      ##
//          #######   ####   ##  ##  #####       ##  #####
//                                           #####
//          Z-Wave, the wireless language.
//
//          Copyright Zensys A/S, 2005
//
//          All Rights Reserved
//
//          Description:   
//
//          Author:   Morten Damsgaard, Linkage A/S
//
//          Last Changed By:  $Author: jrm $
//          Revision:         $Revision: 1.9 $
//          Last Changed:     $Date: 2007/03/02 12:12:21 $
//
//////////////////////////////////////////////////////////////////////////////////////////////
#region Using directives

using System;

#endregion

namespace Zensys.ZWave.Communication
{
    /// <summary>
    ///  COMMAND_CLASS_BASIC
    /// </summary>
    public enum CmdBasic
    {
        /// <summary>
        /// 
        /// </summary>
        BasicVersion = 0x01,
        /// <summary>
        /// 
        /// </summary>
        BasicSet = 0x01,
        /// <summary>
        /// 
        /// </summary>
        BasicGet = 0x02,
        /// <summary>
        /// 
        /// </summary>
        BasicReport = 0x03,
        /// <summary>
        /// 
        /// </summary>
        BasicOn = 0xFF,
        /// <summary>
        /// 
        /// </summary>
        BasicOff = 0x00
    }

    /// <summary>
    /// LibraryType
    /// </summary>
    public enum Library
    {
        /// <summary>
        /// No Library was found 
        /// </summary>
        NoLib = 0x00,
        /// <summary>
        /// A Static Controller library was found
        /// </summary>
        ControllerStaticLib = 0x01,
        /// <summary>
        /// A Controller library was found
        /// </summary>
        ControllerLib = 0x02,
        /// <summary>
        /// A Slave enhanced library was found
        /// </summary>
        SlaveEnhancedLib = 0x03,
        /// <summary>
        /// A Slave library was found
        /// </summary>
        SlaveLib = 0x04,
        /// <summary>
        /// An Installer Library was found 
        /// </summary>
        InstallerLib = 0x05,
        /// <summary>
        /// A Routing slave library was found
        /// </summary>
        SlaveRoutingLib = 0x06,
        /// <summary>
        /// A controller bridge library was found
        /// </summary>
        ControllerBridgeLib = 0x07
    }


    /// <summary>
    /// Text Status
    /// </summary>
    public enum TXStatus
    {
        /// <summary>
        /// Successfully
        /// </summary>
        CompleteOk = 0x00,
        /// <summary>
        /// No acknowledge is received before timeout from the destination node. 
        /// Acknowledge is discarded in case it is received after the timeout.
        /// </summary>
        CompleteNoAcknowledge = 0x01,
        /// <summary>
        /// Not possible to transmit data because the Z-Wave network is busy (jammed).
        /// </summary>
        CompleteFail = 0x02,
        /// <summary>
        /// no route found in Assign Route 
        /// </summary>
        CompleteNoRoute = 0x04,
        /// <summary>
        /// No Communication ACK received
        /// </summary>
        NoAcknowledge = 0x05,
        /// <summary>
        /// No response received
        /// </summary>
        ResMissing = 0x06
    }

    /// <summary>
    /// ZWave hosting Chip types
    /// </summary>
    public enum ChipType
    {
        /// <summary>
        /// 
        /// </summary>
        Unknown = 0,
        /// <summary>
        /// 
        /// </summary>
        ZW0102 = 1,
        /// <summary>
        /// 
        /// </summary>
        ZW0201 = 2
    }
    /// <summary>
    /// Mode
    /// </summary>
    public enum Mode
    {
        /// <summary>
        /// 
        /// </summary>
        None = 0x00,
        /// <summary>
        /// Mode parameters to ZWaveAddNodeToNetwork and ZWaveRemoveNodeFromNetwork  - Add / Remove any node to the network.
        /// </summary>
        NodeAny = 0x01,
        /// <summary>
        /// Mode parameters to ZWaveAddNodeToNetwork, ZWaveRemoveNodeFromNetwork, ZWaveCreateNewPrimary, ZWaveControllerChange - Add a controller to the network
        /// </summary>
        NodeController = 0x02,
        /// <summary>
        /// Mode parameters to ZWaveAddNodeToNetwork ,ZWaveRemoveNodeFromNetwork- Add/Remove a slave node to/from the network
        /// </summary>
        NodeSlave = 0x03,
        /// <summary>
        /// Mode parameters to ZWaveAddNodeToNetwork and ZWaveRemoveNodeFromNetwork
        /// </summary>
        NodeExisting = 0x04,
        /// <summary>
        ///Stop learn mode without reporting an error.ZWaveAddNodeToNetwork, ZWaveRemoveNodeFromNetwork and ZWaveCreateNewPrimary
        /// </summary>
        NodeStop = 0x05,
        /// <summary>
        /// Mode parameters to ZWaveAddNodeToNetwork, ZWaveCreateNewPrimary
        /// </summary>
        NodeStopFailed = 0x06,
    }
    /// <summary>
    /// Modes available for Controller change
    /// </summary>
    public enum ControllerChangeMode
    {
        /// <summary>
        /// Start Change
        /// </summary>
        Start = Mode.NodeController,
        /// <summary>
        /// Stop Change
        /// </summary>
        Stop = Mode.NodeStop,
        /// <summary>
        /// Stop Change. Indicate failed
        /// </summary>
        StopFailed = Mode.NodeStopFailed
    }

    /// <summary>
    /// Modes available for Create new primary ctrl.
    /// </summary>
    public enum CreateNewPrimaryControllerMode
    {
        /// <summary>
        /// Start Change
        /// </summary>
        Start = Mode.NodeController,
        /// <summary>
        /// Stop Change
        /// </summary>
        Stop = Mode.NodeStop,
        /// <summary>
        /// Stop Change. Indicate failed
        /// </summary>
        StopFailed = Mode.NodeStopFailed
    }
    
    /// <summary>
    /// LearnMode
    /// </summary>
    public enum LearnMode
    {
        /// <summary>
        /// 
        /// </summary>
        Unknown = 0x00,
        /// <summary>
        /// Callback states from ZWaveSetLearnMode
        /// </summary>
        Started = 0x01,
        /// <summary>
        /// Callback states from ZWaveSetLearnMode
        /// </summary>
        Done = 0x06,
        /// <summary>
        /// Callback states from ZWaveSetLearnMode
        /// </summary>
        Failed = 0x07,
        /// <summary>
        /// Callback states from ZWaveSetLearnMode
        /// </summary>
        Deleted = 0x80
    }

    /// <summary>
    /// slaveLearnMode
    /// </summary>
    public enum SlaveLearnMode
    {
        /// <summary>
        /// Disable SlaveLearnMode (disable possibility to add/remove Virtual Slave nodes)
        /// Allowed when bridge is a primary controller, an inclusion controller or a secondary controller
        /// </summary>
        VirtualSlaveLearnModeDisable = 0x00,
        /// <summary>
        /// Enable SlaveLearnMode - Enable possibility for including/excluding a
        /// Virtual Slave node by an external primary/inclusion controller
        /// Allowed when bridge is an inclusion controller or a secondary controller
        /// </summary>
        VirtualSlaveLearnModeEnable = 0x01,
        /// <summary>
        /// Add new Virtual Slave node if possible
        /// Allowed when bridge is a primary or an inclusion controller
        /// Slave Learn function done when Callback function returns ASSIGN_NODEID_DONE
        /// </summary>
        VirtualSlaveLearnModeAdd = 0x02,
        /// <summary>
        /// Remove existing Virtual Slave node
        /// Allowed when bridge is a primary or an inclusion controller
        /// Slave Learn function done when Callback function returns ASSIGN_NODEID_DONE
        /// </summary>
        VirtualSlaveLearnModeRemove = 0x03