fcf::devmgr::piezo Namespace Reference

Classes
class	Piezo
	The Piezo class. More...
class	PiezoConfig
	piezo Configuration class More...
struct	PiezoControllerData
	The piezoControllerData struct. More...
class	PiezoLcsIf
	Piezo Local Control System (LCS) Interface (IF) class. More...

Enumerations
enum	{   HW_SUCCESS = 0 , HW_ERR_HW_NOT_OP = 1 , HW_ERR_WRONG_CMD = 2 , HW_ERR_MAXON = 3 ,   HW_ERR_OUT_OF_RANGE = 4 , HW_ERR_USER2BIT_ZERO = 5 }
enum	{   RPC_SUCCESS = 0 , RPC_ERR_NOT_OP = -1 , RPC_ERR_NOT_OP_READY = -2 , RPC_ERR_NOT_OP_NOTREADY = -3 ,   RPC_ERR_LOCAL = -4 , RPC_ERROR_MOVING_USER = -5 , RPC_ERROR_MOVING_BIT = -6 }

Functions
	REGISTER_DEVICE (Piezo)

Variables
constexpr auto	LOGGER_NAME = "piezo"
constexpr auto	CI_MAX_ON = "max_on"
constexpr auto	CI_NUM_AXIS = "num_axis"
constexpr auto	CI_FULL_RANGE1 = "full_range1"
constexpr auto	CI_FULL_RANGE2 = "full_range2"
constexpr auto	CI_FULL_RANGE3 = "full_range3"
constexpr auto	CI_HOME1 = "home1"
constexpr auto	CI_HOME2 = "home2"
constexpr auto	CI_HOME3 = "home3"
constexpr auto	CI_LOWER_LIMIT1 = "lower_limit1"
constexpr auto	CI_LOWER_LIMIT2 = "lower_limit2"
constexpr auto	CI_LOWER_LIMIT3 = "lower_limit3"
constexpr auto	CI_UPPER_LIMIT1 = "upper_limit1"
constexpr auto	CI_UPPER_LIMIT2 = "upper_limit2"
constexpr auto	CI_UPPER_LIMIT3 = "upper_limit3"
constexpr auto	CI_USER_TO_BIT_INPUT1 = "user_to_bit_input1"
constexpr auto	CI_USER_TO_BIT_INPUT2 = "user_to_bit_input2"
constexpr auto	CI_USER_TO_BIT_INPUT3 = "user_to_bit_input3"
constexpr auto	CI_USER_OFFSET_INPUT1 = "user_offset_input1"
constexpr auto	CI_USER_OFFSET_INPUT2 = "user_offset_input2"
constexpr auto	CI_USER_OFFSET_INPUT3 = "user_offset_input3"
constexpr auto	CI_USER_TO_BIT_OUTPUT1 = "user_to_bit_output1"
constexpr auto	CI_USER_TO_BIT_OUTPUT2 = "user_to_bit_output2"
constexpr auto	CI_USER_TO_BIT_OUTPUT3 = "user_to_bit_output3"
constexpr auto	CI_USER_OFFSET_OUTPUT1 = "user_offset_output1"
constexpr auto	CI_USER_OFFSET_OUTPUT2 = "user_offset_output2"
constexpr auto	CI_USER_OFFSET_OUTPUT3 = "user_offset_output3"
constexpr bool	DEFAULT_MAX_ON = 0
constexpr bool	DEFAULT_NUM_AXIS = 2
constexpr short	DEFAULT_FULL_RANGE = 32767
constexpr short	DEFAULT_LOWER_LIMIT = 0
constexpr short	DEFAULT_UPPER_LIMIT = 32767
constexpr short	DEFAULT_USER_OFFSET = 0
constexpr short	DEFAULT_HOME = 0
constexpr double	DEFAULT_USER_TO_BIT = 32767/10.0
constexpr auto	RPC_AUTO = "rpcAuto"
constexpr auto	RPC_HOME = "rpcHome"
constexpr auto	RPC_POS = "rpcPos"
constexpr auto	RPC_MOVEBITS = "rpcMoveBits"
constexpr auto	RPC_MOVEUSER = "rpcMoveUser"
constexpr short	SUBSTATE_OP_POS = 203
constexpr short	SUBSTATE_OP_AUTO = 204
constexpr auto	SUBSTATE_OP_POS_STR = "Pos"
constexpr auto	SUBSTATE_OP_AUTO_STR = "Auto"
const std::unordered_map< short, std::string >	SubstateMap
constexpr auto	CI_STAT_ACTUAL_POS_BIT = "actual_pos_bit"
constexpr auto	CI_STAT_ACTUAL_POS_BIT1 = "actual_pos_bit1"
constexpr auto	CI_STAT_ACTUAL_POS_BIT2 = "actual_pos_bit2"
constexpr auto	CI_STAT_ACTUAL_POS_BIT3 = "actual_pos_bit3"
constexpr auto	CI_STAT_ACTUAL_POS_USER = "actual_pos_user"
constexpr auto	CI_STAT_ACTUAL_POS_USER1 = "actual_pos_user1"
constexpr auto	CI_STAT_ACTUAL_POS_USER2 = "actual_pos_user2"
constexpr auto	CI_STAT_ACTUAL_POS_USER3 = "actual_pos_user3"
constexpr auto	CI_STAT_MON_ACT_POS_BIT = "mon_act_pos_bit"
constexpr auto	CI_STAT_MON_ACT_POS_BIT1 = "mon_act_pos_bit1"
constexpr auto	CI_STAT_MON_ACT_POS_BIT2 = "mon_act_pos_bit2"
constexpr auto	CI_STAT_MON_ACT_POS_BIT3 = "mon_act_pos_bit3"
constexpr auto	CI_STAT_MON_ACT_POS_USR = "mon_act_pos_usr"
constexpr auto	CI_STAT_MON_ACT_POS_USR1 = "mon_act_pos_usr1"
constexpr auto	CI_STAT_MON_ACT_POS_USR2 = "mon_act_pos_usr2"
constexpr auto	CI_STAT_MON_ACT_POS_USR3 = "mon_act_pos_usr3"
const std::unordered_map< short, std::string >	hw_errors
const std::unordered_map< short, std::string >	rpc_errors

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
HW_SUCCESS
HW_ERR_HW_NOT_OP
HW_ERR_WRONG_CMD
HW_ERR_MAXON
HW_ERR_OUT_OF_RANGE
HW_ERR_USER2BIT_ZERO

anonymous enum

anonymous enum

Enumerator
RPC_SUCCESS
RPC_ERR_NOT_OP
RPC_ERR_NOT_OP_READY
RPC_ERR_NOT_OP_NOTREADY
RPC_ERR_LOCAL
RPC_ERROR_MOVING_USER
RPC_ERROR_MOVING_BIT

Function Documentation

REGISTER_DEVICE()

fcf::devmgr::piezo::REGISTER_DEVICE

(

Piezo

)

Variable Documentation

CI_FULL_RANGE1

constexpr auto fcf::devmgr::piezo::CI_FULL_RANGE1 = "full_range1"

constexpr

CI_FULL_RANGE2

constexpr auto fcf::devmgr::piezo::CI_FULL_RANGE2 = "full_range2"

constexpr

CI_FULL_RANGE3

constexpr auto fcf::devmgr::piezo::CI_FULL_RANGE3 = "full_range3"

constexpr

CI_HOME1

constexpr auto fcf::devmgr::piezo::CI_HOME1 = "home1"

constexpr

CI_HOME2

constexpr auto fcf::devmgr::piezo::CI_HOME2 = "home2"

constexpr

CI_HOME3

constexpr auto fcf::devmgr::piezo::CI_HOME3 = "home3"

constexpr

CI_LOWER_LIMIT1

constexpr auto fcf::devmgr::piezo::CI_LOWER_LIMIT1 = "lower_limit1"

constexpr

CI_LOWER_LIMIT2

constexpr auto fcf::devmgr::piezo::CI_LOWER_LIMIT2 = "lower_limit2"

constexpr

CI_LOWER_LIMIT3

constexpr auto fcf::devmgr::piezo::CI_LOWER_LIMIT3 = "lower_limit3"

constexpr

CI_MAX_ON

constexpr auto fcf::devmgr::piezo::CI_MAX_ON = "max_on"

constexpr

CI_NUM_AXIS

constexpr auto fcf::devmgr::piezo::CI_NUM_AXIS = "num_axis"

constexpr

CI_STAT_ACTUAL_POS_BIT

constexpr auto fcf::devmgr::piezo::CI_STAT_ACTUAL_POS_BIT = "actual_pos_bit"

constexpr

CI_STAT_ACTUAL_POS_BIT1

constexpr auto fcf::devmgr::piezo::CI_STAT_ACTUAL_POS_BIT1 = "actual_pos_bit1"

constexpr

CI_STAT_ACTUAL_POS_BIT2

constexpr auto fcf::devmgr::piezo::CI_STAT_ACTUAL_POS_BIT2 = "actual_pos_bit2"

constexpr

CI_STAT_ACTUAL_POS_BIT3

constexpr auto fcf::devmgr::piezo::CI_STAT_ACTUAL_POS_BIT3 = "actual_pos_bit3"

constexpr

CI_STAT_ACTUAL_POS_USER

constexpr auto fcf::devmgr::piezo::CI_STAT_ACTUAL_POS_USER = "actual_pos_user"

constexpr

CI_STAT_ACTUAL_POS_USER1

constexpr auto fcf::devmgr::piezo::CI_STAT_ACTUAL_POS_USER1 = "actual_pos_user1"

constexpr

CI_STAT_ACTUAL_POS_USER2

constexpr auto fcf::devmgr::piezo::CI_STAT_ACTUAL_POS_USER2 = "actual_pos_user2"

constexpr

CI_STAT_ACTUAL_POS_USER3

constexpr auto fcf::devmgr::piezo::CI_STAT_ACTUAL_POS_USER3 = "actual_pos_user3"

constexpr

CI_STAT_MON_ACT_POS_BIT

constexpr auto fcf::devmgr::piezo::CI_STAT_MON_ACT_POS_BIT = "mon_act_pos_bit"

constexpr

CI_STAT_MON_ACT_POS_BIT1

constexpr auto fcf::devmgr::piezo::CI_STAT_MON_ACT_POS_BIT1 = "mon_act_pos_bit1"

constexpr

CI_STAT_MON_ACT_POS_BIT2

constexpr auto fcf::devmgr::piezo::CI_STAT_MON_ACT_POS_BIT2 = "mon_act_pos_bit2"

constexpr

CI_STAT_MON_ACT_POS_BIT3

constexpr auto fcf::devmgr::piezo::CI_STAT_MON_ACT_POS_BIT3 = "mon_act_pos_bit3"

constexpr

CI_STAT_MON_ACT_POS_USR

constexpr auto fcf::devmgr::piezo::CI_STAT_MON_ACT_POS_USR = "mon_act_pos_usr"

constexpr

CI_STAT_MON_ACT_POS_USR1

constexpr auto fcf::devmgr::piezo::CI_STAT_MON_ACT_POS_USR1 = "mon_act_pos_usr1"

constexpr

CI_STAT_MON_ACT_POS_USR2

constexpr auto fcf::devmgr::piezo::CI_STAT_MON_ACT_POS_USR2 = "mon_act_pos_usr2"

constexpr

CI_STAT_MON_ACT_POS_USR3

constexpr auto fcf::devmgr::piezo::CI_STAT_MON_ACT_POS_USR3 = "mon_act_pos_usr3"

constexpr

CI_UPPER_LIMIT1

constexpr auto fcf::devmgr::piezo::CI_UPPER_LIMIT1 = "upper_limit1"

constexpr

CI_UPPER_LIMIT2

constexpr auto fcf::devmgr::piezo::CI_UPPER_LIMIT2 = "upper_limit2"

constexpr

CI_UPPER_LIMIT3

constexpr auto fcf::devmgr::piezo::CI_UPPER_LIMIT3 = "upper_limit3"

constexpr

CI_USER_OFFSET_INPUT1

constexpr auto fcf::devmgr::piezo::CI_USER_OFFSET_INPUT1 = "user_offset_input1"

constexpr

CI_USER_OFFSET_INPUT2

constexpr auto fcf::devmgr::piezo::CI_USER_OFFSET_INPUT2 = "user_offset_input2"

constexpr

CI_USER_OFFSET_INPUT3

constexpr auto fcf::devmgr::piezo::CI_USER_OFFSET_INPUT3 = "user_offset_input3"

constexpr

CI_USER_OFFSET_OUTPUT1

constexpr auto fcf::devmgr::piezo::CI_USER_OFFSET_OUTPUT1 = "user_offset_output1"

constexpr

CI_USER_OFFSET_OUTPUT2

constexpr auto fcf::devmgr::piezo::CI_USER_OFFSET_OUTPUT2 = "user_offset_output2"

constexpr

CI_USER_OFFSET_OUTPUT3

constexpr auto fcf::devmgr::piezo::CI_USER_OFFSET_OUTPUT3 = "user_offset_output3"

constexpr

CI_USER_TO_BIT_INPUT1

constexpr auto fcf::devmgr::piezo::CI_USER_TO_BIT_INPUT1 = "user_to_bit_input1"

constexpr

CI_USER_TO_BIT_INPUT2

constexpr auto fcf::devmgr::piezo::CI_USER_TO_BIT_INPUT2 = "user_to_bit_input2"

constexpr

CI_USER_TO_BIT_INPUT3

constexpr auto fcf::devmgr::piezo::CI_USER_TO_BIT_INPUT3 = "user_to_bit_input3"

constexpr

CI_USER_TO_BIT_OUTPUT1

constexpr auto fcf::devmgr::piezo::CI_USER_TO_BIT_OUTPUT1 = "user_to_bit_output1"

constexpr

CI_USER_TO_BIT_OUTPUT2

constexpr auto fcf::devmgr::piezo::CI_USER_TO_BIT_OUTPUT2 = "user_to_bit_output2"

constexpr

CI_USER_TO_BIT_OUTPUT3

constexpr auto fcf::devmgr::piezo::CI_USER_TO_BIT_OUTPUT3 = "user_to_bit_output3"

constexpr

DEFAULT_FULL_RANGE

constexpr short fcf::devmgr::piezo::DEFAULT_FULL_RANGE = 32767

constexpr

DEFAULT_HOME

constexpr short fcf::devmgr::piezo::DEFAULT_HOME = 0

constexpr

DEFAULT_LOWER_LIMIT

constexpr short fcf::devmgr::piezo::DEFAULT_LOWER_LIMIT = 0

constexpr

DEFAULT_MAX_ON

constexpr bool fcf::devmgr::piezo::DEFAULT_MAX_ON = 0

constexpr

DEFAULT_NUM_AXIS

constexpr bool fcf::devmgr::piezo::DEFAULT_NUM_AXIS = 2

constexpr

DEFAULT_UPPER_LIMIT

constexpr short fcf::devmgr::piezo::DEFAULT_UPPER_LIMIT = 32767

constexpr

DEFAULT_USER_OFFSET

constexpr short fcf::devmgr::piezo::DEFAULT_USER_OFFSET = 0

constexpr

DEFAULT_USER_TO_BIT

constexpr double fcf::devmgr::piezo::DEFAULT_USER_TO_BIT = 32767/10.0

constexpr

hw_errors

const std::unordered_map<short, std::string> fcf::devmgr::piezo::hw_errors

Initial value:

= {
      {HW_ERR_HW_NOT_OP,       "TwinCAT not in OP state or CouplerState not mapped"},
      {HW_ERR_WRONG_CMD,       "Piezo unknown command"},
      {HW_ERR_MAXON,           "Piezo maximum ON time exceeded"},
      {HW_ERR_OUT_OF_RANGE,    "Piezo values out of range"},
      {HW_ERR_USER2BIT_ZERO,   "Piezo wrong scale conversion factor"},
    }

LOGGER_NAME

constexpr auto fcf::devmgr::piezo::LOGGER_NAME = "piezo"

constexpr

RPC_AUTO

constexpr auto fcf::devmgr::piezo::RPC_AUTO = "rpcAuto"

constexpr

rpc_errors

const std::unordered_map<short, std::string> fcf::devmgr::piezo::rpc_errors

Initial value:

= {
    {RPC_ERR_NOT_OP,          "Cannot disable Piezo. Not in OP state"},
    {RPC_ERR_NOT_OP_READY,    "Cannot enable Piezo. Not in NOT_OP_READY."},
    {RPC_ERR_NOT_OP_NOTREADY, "Cannot init Piezo. Not in NOT_OP_NOTREADY or FAILURE."},
    {RPC_ERR_LOCAL,           "RPC calls are not allowed in Local mode"},
    {RPC_ERROR_MOVING_USER,   "Out of limits target when moving in UU"},
    {RPC_ERROR_MOVING_BIT,    "Out of limits target when moving in bits"}
  }

RPC_HOME

constexpr auto fcf::devmgr::piezo::RPC_HOME = "rpcHome"

constexpr

RPC_MOVEBITS

constexpr auto fcf::devmgr::piezo::RPC_MOVEBITS = "rpcMoveBits"

constexpr

RPC_MOVEUSER

constexpr auto fcf::devmgr::piezo::RPC_MOVEUSER = "rpcMoveUser"

constexpr

RPC_POS

constexpr auto fcf::devmgr::piezo::RPC_POS = "rpcPos"

constexpr

SUBSTATE_OP_AUTO

constexpr short fcf::devmgr::piezo::SUBSTATE_OP_AUTO = 204

constexpr

SUBSTATE_OP_AUTO_STR

constexpr auto fcf::devmgr::piezo::SUBSTATE_OP_AUTO_STR = "Auto"

constexpr

SUBSTATE_OP_POS

constexpr short fcf::devmgr::piezo::SUBSTATE_OP_POS = 203

constexpr

SUBSTATE_OP_POS_STR

constexpr auto fcf::devmgr::piezo::SUBSTATE_OP_POS_STR = "Pos"

constexpr

SubstateMap

const std::unordered_map<short, std::string> fcf::devmgr::piezo::SubstateMap

Initial value:

= {
    {fcf::devmgr::common::SUBSTATE_NOTREADY,       fcf::devmgr::common::SUBSTATE_NOTREADY_STR},
    {fcf::devmgr::common::SUBSTATE_INITIALISING,   fcf::devmgr::common::SUBSTATE_INITIALISING_STR},
    {fcf::devmgr::common::SUBSTATE_ERROR,          fcf::devmgr::common::SUBSTATE_ERROR_STR},
    {SUBSTATE_OP_POS,       SUBSTATE_OP_POS_STR},
    {SUBSTATE_OP_AUTO,     SUBSTATE_OP_AUTO_STR},
    {fcf::devmgr::common::SUBSTATE_OP_ERROR,       fcf::devmgr::common::SUBSTATE_OP_ERROR_STR}
  }