Ocp1ObjectDefinitions.h

Go to the documentation of this file.

/* Copyright (c) 2023, Bernardo Escalona
 *
 * This file is part of NanoOcp <https://github.com/ChristianAhrens/NanoOcp>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3.0 as published
 * by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
 
#include "Ocp1Message.h"
#include "Ocp1DataTypes.h"
 
 
namespace NanoOcp1
{
 
typedef std::uint32_t BoxAndObjNo;
 
static constexpr int DefLevel_OcaRoot               = 1;
static constexpr int DefLevel_OcaAgent              = 1 + DefLevel_OcaRoot;
static constexpr int DefLevel_OcaWorker             = 1 + DefLevel_OcaRoot;
static constexpr int DefLevel_OcaActuator           = 1 + DefLevel_OcaWorker;
static constexpr int DefLevel_OcaPolarity           = 1 + DefLevel_OcaActuator;
static constexpr int DefLevel_OcaSwitch             = 1 + DefLevel_OcaActuator;
static constexpr int DefLevel_OcaGain               = 1 + DefLevel_OcaActuator;
static constexpr int DefLevel_OcaMute               = 1 + DefLevel_OcaActuator;
static constexpr int DefLevel_OcaDelay              = 1 + DefLevel_OcaActuator;
static constexpr int DefLevel_OcaBasicActuator      = 1 + DefLevel_OcaActuator;
static constexpr int DefLevel_OcaInt32Actuator      = 1 + DefLevel_OcaBasicActuator;
static constexpr int DefLevel_OcaFloat32Actuator    = 1 + DefLevel_OcaBasicActuator;
static constexpr int DefLevel_OcaStringActuator     = 1 + DefLevel_OcaBasicActuator;
static constexpr int DefLevel_OcaSensor             = 1 + DefLevel_OcaWorker;
static constexpr int DefLevel_OcaLevelSensor        = 1 + DefLevel_OcaSensor;
static constexpr int DefLevel_OcaAudioLevelSensor   = 1 + DefLevel_OcaLevelSensor;
static constexpr int DefLevel_OcaBasicSensor        = 1 + DefLevel_OcaSensor;
static constexpr int DefLevel_OcaBooleanSensor      = 1 + DefLevel_OcaBasicSensor;
static constexpr int DefLevel_OcaInt32Sensor        = 1 + DefLevel_OcaBasicSensor;
static constexpr int DefLevel_OcaStringSensor       = 1 + DefLevel_OcaBasicSensor;
 
static constexpr int DefLevel_dbOcaDataTransfer                     = 1 + DefLevel_OcaAgent;         
static constexpr int DefLevel_dbOcaSceneAgent                       = 1 + DefLevel_dbOcaDataTransfer; 
static constexpr int DefLevel_dbOcaPositionAgentDeprecated          = 1 + DefLevel_OcaAgent;          
static constexpr int DefLevel_dbOcaSpeakerPositionAgentDeprecated   = 1 + DefLevel_dbOcaPositionAgentDeprecated; 
//==============================================================================
namespace AmpGeneric
{
 
static constexpr BoxAndObjNo Config_Mute        = 0x205;
static constexpr BoxAndObjNo Config_PotiLevel   = 0x206;
 
struct dbOcaObjectDef_Config_PotiLevel : Ocp1CommandDefinition
{
    dbOcaObjectDef_Config_PotiLevel(std::uint32_t channel)
        : Ocp1CommandDefinition(GetONo(0x01, 0x00, channel, Config_PotiLevel), // ONO of Config_PotiLevel
            OCP1DATATYPE_FLOAT32,           // Value type
            DefLevel_OcaGain,
            1)                              // Prop_Gain
    {
    }
};
 
struct dbOcaObjectDef_Config_Mute : Ocp1CommandDefinition
{
    dbOcaObjectDef_Config_Mute(std::uint32_t channel)
        : Ocp1CommandDefinition(GetONo(0x01, 0x00, channel, Config_Mute), // ONO of Config_Mute
            OCP1DATATYPE_UINT8,             // Value type
            DefLevel_OcaMute,
            1)                              // Prop_Setting
    {
    }
};
}
 
 
//==============================================================================
// Dx and Dy amplifiers
//==============================================================================
namespace AmpDxDy
{
 
static constexpr BoxAndObjNo Settings_PwrOn     = 0x100;
static constexpr BoxAndObjNo ChStatus_Isp       = 0x400;
static constexpr BoxAndObjNo ChStatus_Gr        = 0x401;
static constexpr BoxAndObjNo ChStatus_Ovl       = 0x402;
 
struct dbOcaObjectDef_Settings_PwrOn : Ocp1CommandDefinition
{
    dbOcaObjectDef_Settings_PwrOn() 
        : Ocp1CommandDefinition(GetONo(0x01, 0x00, 0x00, Settings_PwrOn), // ONO of Settings_PwrOn
            OCP1DATATYPE_UINT16,             // Value type
            DefLevel_OcaSwitch,
            1)                              // Prop_Setting
    {
    }
};
 
struct dbOcaObjectDef_ChStatus_Isp : Ocp1CommandDefinition
{
    dbOcaObjectDef_ChStatus_Isp(std::uint32_t channel)
        : Ocp1CommandDefinition(GetONo(0x01, 0x00, channel, ChStatus_Isp), // ONO of ChStatus_Isp
                                OCP1DATATYPE_BOOLEAN,           // Value type
                                DefLevel_OcaBooleanSensor,
                                1)                              // Prop_Reading
    {
    }
};
 
struct dbOcaObjectDef_ChStatus_Gr : Ocp1CommandDefinition
{
    dbOcaObjectDef_ChStatus_Gr(std::uint32_t channel)
        : Ocp1CommandDefinition(GetONo(0x01, 0x00, channel, ChStatus_Gr), // ONO of ChStatus_Gr
                                OCP1DATATYPE_BOOLEAN,           // Value type
                                DefLevel_OcaBooleanSensor,
                                1)                              // Prop_Reading
    {
    }
};
 
struct dbOcaObjectDef_ChStatus_Ovl : Ocp1CommandDefinition
{
    dbOcaObjectDef_ChStatus_Ovl(std::uint32_t channel)
        : Ocp1CommandDefinition(GetONo(0x01, 0x00, channel, ChStatus_Ovl), // ONO of ChStatus_Ovl
            OCP1DATATYPE_BOOLEAN,           // Value type
            DefLevel_OcaBooleanSensor,
            1)                              // Prop_Reading
    {
    }
};
 
}
 
 
//==============================================================================
// Dx amplifier
//==============================================================================
namespace AmpDx // NOTE: namespaces starting with numbers cause problems
{
 
static constexpr BoxAndObjNo ChStatus_GrHead = 0x40c;
 
struct dbOcaObjectDef_ChStatus_GrHead : Ocp1CommandDefinition
{
    dbOcaObjectDef_ChStatus_GrHead(std::uint32_t channel)
        : Ocp1CommandDefinition(GetONo(0x01, 0x00, channel, ChStatus_GrHead), // ONO of ChStatus_GrHead
            OCP1DATATYPE_FLOAT32,           // Value type
            DefLevel_OcaAudioLevelSensor,
            1)                              // Prop_Reading ?
    {
    }
};
 
}
 
 
//==============================================================================
// Dy amplifier
//==============================================================================
namespace AmpDy // NOTE: namespaces starting with numbers cause problems
{
 
static constexpr BoxAndObjNo ChStatus_GrHead = 0x40a;
 
struct dbOcaObjectDef_ChStatus_GrHead : Ocp1CommandDefinition
{
    dbOcaObjectDef_ChStatus_GrHead(std::uint32_t channel)
        : Ocp1CommandDefinition(GetONo(0x01, 0x00, channel, ChStatus_GrHead), // ONO of ChStatus_GrHead
            OCP1DATATYPE_FLOAT32,           // Value type
            DefLevel_OcaAudioLevelSensor,
            1)                              // Prop_Reading ?
    {
    }
};
 
}
 
 
//==============================================================================
// 5D amplifier
//==============================================================================
namespace Amp5D // NOTE: namespaces starting with numbers cause problems
{
 
static constexpr BoxAndObjNo Settings_PwrOn     = 0x101; 
static constexpr BoxAndObjNo ChStatus_Isp       = 0x401;
static constexpr BoxAndObjNo ChStatus_Gr        = 0x402;
static constexpr BoxAndObjNo ChStatus_Ovl       = 0x403;
static constexpr BoxAndObjNo ChStatus_GrHead    = 0x404;
 
struct dbOcaObjectDef_Settings_PwrOn : Ocp1CommandDefinition
{
    dbOcaObjectDef_Settings_PwrOn()
        : Ocp1CommandDefinition(GetONo(0x01, 0x00, 0x00, Settings_PwrOn), // ONO of Settings_PwrOn
            OCP1DATATYPE_UINT16,             // Value type
            DefLevel_OcaSwitch,
            1)                              // Prop_Setting
    {
    }
};
 
struct dbOcaObjectDef_ChStatus_Isp : Ocp1CommandDefinition
{
    dbOcaObjectDef_ChStatus_Isp(std::uint32_t channel)
        : Ocp1CommandDefinition(GetONo(0x01, 0x00, channel, ChStatus_Isp), // ONO of ChStatus_Isp
            OCP1DATATYPE_BOOLEAN,           // Value type
            DefLevel_OcaBooleanSensor,
            1)                              // Prop_Reading
    {
    }
};
 
struct dbOcaObjectDef_ChStatus_Gr : Ocp1CommandDefinition
{
    dbOcaObjectDef_ChStatus_Gr(std::uint32_t channel)
        : Ocp1CommandDefinition(GetONo(0x01, 0x00, channel, ChStatus_Gr), // ONO of ChStatus_Gr
            OCP1DATATYPE_BOOLEAN,           // Value type
            DefLevel_OcaBooleanSensor,
            1)                              // Prop_Reading
    {
    }
};
 
struct dbOcaObjectDef_ChStatus_Ovl : Ocp1CommandDefinition
{
    dbOcaObjectDef_ChStatus_Ovl(std::uint32_t channel)
        : Ocp1CommandDefinition(GetONo(0x01, 0x00, channel, ChStatus_Ovl), // ONO of ChStatus_Ovl
            OCP1DATATYPE_BOOLEAN,           // Value type
            DefLevel_OcaBooleanSensor,
            1)                              // Prop_Reading
    {
    }
};
 
struct dbOcaObjectDef_ChStatus_GrHead : Ocp1CommandDefinition
{
    dbOcaObjectDef_ChStatus_GrHead(std::uint32_t channel)
        : Ocp1CommandDefinition(GetONo(0x01, 0x00, channel, ChStatus_GrHead), // ONO of ChStatus_GrHead
            OCP1DATATYPE_FLOAT32,           // Value type
            DefLevel_OcaAudioLevelSensor,
            1)                              // Prop_Reading ?
    {
    }
};
 
}
 
}