PHApp Class Reference

#include <PHApp.h>

Inheritance diagram for PHApp:

Public Types
enum	APP_STATE {   RESET = 0, EXTRUDING = 1, STANDBY = 2, ERROR = 5,   VFD_TIMEOUT = 10, PID_TIMEOUT = 11, FEED_TIMEOUT = 12, CONTROL_PANEL_INVALID = 13,   PID_ERROR = 20, VFD_ERROR = 30, FEED_ERROR = 40 }
enum	CONTROLLER_STATE { E_CS_OK = 0, E_CS_ERROR = 10 }

Public Member Functions
short	clearError ()
short	getAppState (short val)
StepperController *	getExtruderFeed ()
short	getLastError ()
virtual short	list (short val0, short val1)
short	loop ()
short	loopExtruderFeed ()
short	loopModbus ()
short	onError (short id, short code)
virtual short	onRegisterMethods (Bridge *bridge)
short	onRun (short code=0)
short	onStop (short code=0)
short	onWarning (short code)
	PHApp ()
short	print (short arg1, short arg2)
void	printRegisters ()
short	reset ()
short	setAppState (short newState)
void	setExtruderFeed (StepperController *feed)
short	setLastError (short val=0)
virtual short	setup ()

Public Attributes
short	_cstate
short	_error
short	_state
SerialMessage *	com_serial
millis_t	comTS
StepperController *	extruderFeed
millis_t	loopTS
MotorLoad *	mLoad
ModbusBridge *	modbusBridge
OmronVFD *	omronVFD
OmronPID *	pids
Pos3Analog *	pos3Analog_0
Pos3Analog *	pos3Analog_1
POT *	pot_0
POT *	pot_1
POT *	pot_2
Relay *	relay_0
Relay *	relay_1
Relay *	relay_2
Relay *	relay_3
Relay *	relay_4
Relay *	relay_5
Relay *	relay_6
Relay *	relay_7
StatusLight *	statusLight_0
StatusLight *	statusLight_1
StepperController *	stepperController_0
StepperController *	stepperController_1
Timer< 10, millis >	timer
millis_t	wait
millis_t	waitTS

Detailed Description

Definition at line 34 of file PHApp.h.

Member Enumeration Documentation

APP_STATE

enum PHApp::APP_STATE

Enumerator
RESET
EXTRUDING
STANDBY
ERROR
VFD_TIMEOUT
PID_TIMEOUT
FEED_TIMEOUT
CONTROL_PANEL_INVALID
PID_ERROR
VFD_ERROR
FEED_ERROR

Definition at line 43 of file PHApp.h.

    {
        RESET = 0,
        EXTRUDING = 1,
        STANDBY = 2,
        ERROR = 5,
        VFD_TIMEOUT = 10,
        PID_TIMEOUT = 11,
        FEED_TIMEOUT = 12,
        CONTROL_PANEL_INVALID = 13,
        PID_ERROR = 20,
        VFD_ERROR = 30,
        FEED_ERROR = 40,
    };

CONTROLLER_STATE

enum PHApp::CONTROLLER_STATE

Enumerator
E_CS_OK
E_CS_ERROR

Definition at line 38 of file PHApp.h.

    {
        E_CS_OK = 0,
        E_CS_ERROR = 10
    };

Constructor & Destructor Documentation

PHApp()

PHApp::PHApp ( )

inline

Definition at line 57 of file PHApp.h.

            : App()
    {
    }

Member Function Documentation

clearError()

short PHApp::clearError

(

)

Definition at line 319 of file PHApp.cpp.

{
  Log.verboseln(F("* App:clearError - " CR));
  STATUS_ERROR_OFF;
  STATUS_ERROR_BLINK_OFF;
  STATUS_WARNING_OFF;
  STATUS_WARNING_BLINK_OFF;
  setLastError(E_OK);
}

getAppState()

short PHApp::getAppState

(

short

val

)

Definition at line 425 of file PHApp.cpp.

{
  return E_OK;
}

getExtruderFeed()

StepperController* PHApp::getExtruderFeed ( )

inline

Definition at line 91 of file PHApp.h.

{ return extruderFeed; }

getLastError()

short PHApp::getLastError ( )

inline

Definition at line 103 of file PHApp.h.

    {
        return _error;
    }

list()

short PHApp::list ( short  val0, short  val1  )

virtual

Definition at line 96 of file PHApp.cpp.

{
  uchar s = components.size();
  for (uchar i = 0; i < s; i++)
  {
    Component *component = components[i];
    Log.verboseln("PHApp::list - %d | %s", component->id, component->name.c_str());
  }
  return E_OK;
}

loop()

short PHApp::loop

(

)

Definition at line 418 of file PHApp.cpp.

{
  App::loop();
  loopExtruderFeed();
  loopModbus();
  return E_OK;
}

loopExtruderFeed()

short PHApp::loopExtruderFeed

(

)

Definition at line 329 of file PHApp.cpp.

{
 
#ifdef HAS_FEED_SERVO
  if (!extruderFeed)
  {
    return E_INVALID_PARAMETERS;
  }
 
  if (extruderFeed->isOverloaded())
  {
    extruderFeed->speed(0);
    if (omronVFD)
    {
      omronVFD->stop();
    }
    onError(extruderFeed->id, E_FEED_OVERLOAD);
    return E_FEED_OVERLOAD;
  }
 
#if defined(MB_W_FEED_VFD_RATIO) && defined(MB_RW_FEED_VFD_DEFAULT_SPEED_RATIO)
  OmronVFDState *state = omronVFD->getVFDState();
  if (omronVFD->direction != OmronVFD::E_VFD_DIR::E_VFD_DIR_FORWARD)
  {
    extruderFeed->speed(0);
    return E_OK;
  }
  int netRatio = modbusBridge->mb->R[MB_W_FEED_VFD_RATIO];
  int vfdState = state->state;
  int vfdSpeed = state->FC;
  int t0 = ((OMRON_VFD_MAX_FREQ * 100 / netRatio) / 100);
  int t1 = t0 * STEPPER_MAX_SPEED_0 / 100;
  int newSpeed = abs(t1 * vfdSpeed / 100);
  switch (vfdState)
  {
  case OMRON_STATE_RUNNING:
  case OMRON_STATE_DECELERATING:
  case OMRON_STATE_ACCELERATING:
  {
    extruderFeed->speed(newSpeed);
    break;
  }
  default:
    extruderFeed->speed(0);
    break;
  }
#endif
#endif
}

loopModbus()

short PHApp::loopModbus

(

)

Definition at line 378 of file PHApp.cpp.

{
  if (!modbusBridge)
  {
    return E_OK;
  }
  Mudbus *mb = modbusBridge->mb;
 
  mb->R[MB_R_SYSTEM_ERROR] = getLastError();
  if (mb->R[MB_R_APP_STATE_REG] == MB_R_SYSTEM_CMD_PRINT_REGS)
  {
    printRegisters();
    mb->R[MB_R_APP_STATE_REG] = 0;
  }
  if (mb->R[MB_R_APP_STATE_REG] == MB_R_SYSTEM_CMD_PRINT_QUEUE)
  {
    modbusBridge->print();
    mb->R[MB_R_APP_STATE_REG] = 0;
  }
  if (mb->R[MB_R_APP_STATE_REG] == MB_R_SYSTEM_CMD_PRINT_MEMORY)
  {
    printMemory();
    mb->R[MB_R_APP_STATE_REG] = 0;
  }
  if (mb->R[MB_R_APP_STATE_REG] == MB_R_SYSTEM_CMD_PRINT_VFD)
  {
    omronVFD->getVFDState()->print();
    mb->R[MB_R_APP_STATE_REG] = 0;
  }
  if (pids && mb->R[MB_R_APP_STATE_REG] == MB_R_SYSTEM_CMD_PRINT_PIDS)
  {
    mb->R[MB_R_APP_STATE_REG] = 0;
    pids->printStates();
  }
  if (mb->R[MB_W_RESET_REG] == 1)
  {
    reset();
  }
  return E_OK;
}

onError()

short PHApp::onError	(	short	id,
		short	code
	)

Definition at line 278 of file PHApp.cpp.

{
  if (code == getLastError())
  {
    return code;
  }
 
  Log.error(F("* App:onError - component=%d (%s) code=%d" CR), byId(id)->name.c_str(), id, code);
  switch (code)
  {
  case E_VFD_TIMEOUT:
  case E_PID_TIMEOUT:
  {
    Log.errorln("App::onError  Timeout %d", id);
    break;
  }
  case E_FEED_OVERLOAD:
  case E_VFD_OVERLOAD:
  {
    Log.errorln("App::onError Overload %d", id);
    break;
  }
 
  default:
    break;
  }
 
  STATUS_WARNING_ON;
  STATUS_WARNING_BLINK;
  STATUS_ERROR_ON;
  STATUS_ERROR_BLINK;
  setLastError(code);
  return code;
}

onRegisterMethods()

short PHApp::onRegisterMethods ( Bridge *  bridge )

virtual

Definition at line 251 of file PHApp.cpp.

{
  Log.verbose(F("* App:onRegisterMethods *" CR));
  bridge->registerMemberFunction(COMPONENT_KEY::COMPONENT_KEY_APP, this, C_STR("print"), (ComponentFnPtr)&PHApp::print);
  bridge->registerMemberFunction(COMPONENT_KEY::COMPONENT_KEY_APP, this, C_STR("list"), (ComponentFnPtr)&PHApp::list);
  bridge->registerMemberFunction(COMPONENT_KEY::COMPONENT_KEY_APP, this, C_STR("printRegisters"), (ComponentFnPtr)&PHApp::printRegisters);
  return E_OK;
}

onRun()

short PHApp::onRun

(

short

code = 0

)

Definition at line 272 of file PHApp.cpp.

{
  STATUS_WARNING_ON;
  STATUS_WARNING_BLINK_OFF;
  return E_OK;
}

onStop()

short PHApp::onStop

(

short

code = 0

)

Definition at line 312 of file PHApp.cpp.

{
  Log.verboseln(F("* App:onStop - " CR));
  STATUS_WARNING_OFF;
  STATUS_WARNING_BLINK_OFF;
}

onWarning()

short PHApp::onWarning

(

short

code

)

Definition at line 260 of file PHApp.cpp.

{
  Log.warning(F("* App:onWarning - code=%d" CR), code);
  if (statusLight_0)
  {
    statusLight_0->setBlink(true);
  }
  STATUS_WARNING_ON;
  STATUS_WARNING_BLINK;
 
  return E_OK;
}

print()

short PHApp::print	(	short	arg1,
		short	arg2
	)

Definition at line 45 of file PHApp.cpp.

{
  uchar s = components.size();
  for (uchar i = 0; i < s; i++)
  {
    Component *component = components[i];
    component->info();
  }
  return E_OK;
}

printRegisters()

void PHApp::printRegisters

(

)

Definition at line 56 of file PHApp.cpp.

{
 
#if ENABLED(HAS_MODBUS_REGISTER_DESCRIPTIONS)
  Log.setShowLevel(false);
  Serial.print("| Name | ID  | Address | RW |  Function Code | Number Addresses |Register Description| \n");
  Serial.print("|------|----------|----|----|----|----|-------|\n");
  short size = components.size();
  for (int i = 0; i < size; i++)
  {
    Component *component = components[i];
    if (!(component->nFlags & 1 << OBJECT_NET_CAPS::E_NCAPS_MODBUS))
    {
      continue;
    }
    Log.verbose("| %s | %d | %d | %s | %d | %d | %s |\n",
                (Component *)component->name.c_str(),
                component->id,
                component->getAddress(),
                component->getRegisterMode(),
                component->getFunctionCode(),
                component->getNumberAddresses(),
                component->getRegisterDescription().c_str());
  }
  Log.setShowLevel(true);
#endif
}

reset()

short PHApp::reset

(

)

Definition at line 84 of file PHApp.cpp.

{
#ifdef ARDUINO
  // Reset code for Arduino
  asm volatile("jmp 0");
#endif
#ifdef ESP8266
  ESP.restart();
#endif
  return E_NOT_IMPLEMENTED;
}

setAppState()

short PHApp::setAppState

(

short

newState

)

setExtruderFeed()

void PHApp::setExtruderFeed ( StepperController *  feed )

inline

Definition at line 90 of file PHApp.h.

{ extruderFeed = feed; }

setLastError()

short PHApp::setLastError ( short  val = 0 )

inline

Definition at line 107 of file PHApp.h.

    {
        _error = val;
        return _error;
    };

setup()

short PHApp::setup ( )

virtual

Definition at line 106 of file PHApp.cpp.

{
  Serial.begin(SERIAL_BAUD_RATE);
  while (!Serial && !Serial.available())
  {
  }
  Log.begin(LOG_LEVEL_VERBOSE, &Serial);
  setFlag(OBJECT_RUN_FLAGS::E_OF_DEBUG);
  Ethernet.begin(mac, ip, gateway, subnet);
  bridge = new Bridge(this);
  com_serial = new SerialMessage(Serial, bridge);
  components.push_back(com_serial);
  components.push_back(bridge);
 
#ifdef MODBUS_BRIDGE
  modbusBridge = new ModbusBridge(this);
  components.push_back(modbusBridge);
#endif
 
#ifdef OMRON_PID_SLAVE_START
  pids = new OmronPID(modbusBridge, OMRON_PID_SLAVE_START);
  components.push_back(pids);
#endif
 
#ifdef MB_RELAY_0
  ADD_RELAY(0, MB_RELAY_0, COMPONENT_KEY_MB_RELAY_0, MB_R_RELAY_0);
#endif
 
#ifdef MB_RELAY_1
  ADD_RELAY(1, MB_RELAY_1, COMPONENT_KEY_MB_RELAY_1, MB_R_RELAY_1);
#endif
 
#ifdef MB_ANALOG_0
  ADD_POT(0, MB_ANALOG_0, COMPONENT_KEY_MB_ANALOG_0, MB_R_ANALOG_0);
#endif
 
#ifdef MB_ANALOG_1
  ADD_POT(1, MB_ANALOG_1, COMPONENT_KEY_MB_ANALOG_1, MB_R_ANALOG_1);
#endif
 
#if (defined(MB_ANALOG_3POS_SWITCH_0) && (defined(MB_ANALOG_3POS_SWITCH_1)))
  ADD_POS3ANALOG(0, MB_ANALOG_3POS_SWITCH_0, MB_ANALOG_3POS_SWITCH_1, COMPONENT_KEY_MB_ANALOG_3POS_SWITCH_0, MB_R_SWITCH_0);
#endif
 
#if (defined(MB_ANALOG_3POS_SWITCH_2) && (defined(MB_ANALOG_3POS_SWITCH_3)))
  ADD_POS3ANALOG(1, MB_ANALOG_3POS_SWITCH_2, MB_ANALOG_3POS_SWITCH_3, COMPONENT_KEY_MB_ANALOG_3POS_SWITCH_1, MB_R_SWITCH_1);
#endif
 
#ifdef HAS_OMRON_VFD_MODBUS
  omronVFD = new OmronVFD(modbusBridge, OMRON_MX2_SLAVE_ID, this);
  components.push_back(omronVFD);
  omronVFD->mode = pos3Analog_0;
  omronVFD->dir = pos3Analog_1;
  omronVFD->speed = pot_1;
  omronVFD->owner = this;
#endif
 
#ifdef HAS_FEED_SERVO
  stepperController_0 = new StepperController(this,
                                              MB_STEPPER_DIR_0, MB_STEPPER_PULSE_0, MB_STEPPER_FEEDBACK_0, MB_STEPPER_OVERLOAD_0, MB_STEPPER_ENABLED_0,
                                              STEPPER_DEFAULT_SPEED_0,
                                              STEPPER_PULSE_WIDTH_0,
                                              STEPPER_DEFAULT_DIR_0,
                                              COMPONENT_KEY_STEPPER_0,
                                              MB_RW_STEPPER_SPEED_0);
  components.push_back(stepperController_0);
  stepperController_0->setGateway(modbusBridge->getMudbus());
#endif
 
#ifdef MOTOR_LOAD_PIN
  mLoad = new MotorLoad(this, MOTOR_LOAD_PIN, COMPONENT_KEY_VFD_LOAD, MB_R_VFD_LOAD);
  components.push_back(mLoad);
  mLoad->setGateway(modbusBridge->getMudbus());
#ifdef OMRON_MX2_SLAVE_ID
  if (omronVFD)
  {
    omronVFD->motorLoad = mLoad;
  }
#endif
 
#endif
 
#ifdef HAS_STATUS
  statusLight_0 = new StatusLight(this,
                                  STATUS_WARNING_PIN,
                                  COMPONENT_KEY_FEEDBACK_0,
                                  MB_MONITORING_STATUS_FEEDBACK_0);
  components.push_back(statusLight_0);
  statusLight_0->setGateway(modbusBridge->getMudbus());
 
  statusLight_1 = new StatusLight(this,
                                  STATUS_ERROR_PIN,
                                  COMPONENT_KEY_FEEDBACK_1,
                                  MB_MONITORING_STATUS_FEEDBACK_1);
  components.push_back(statusLight_1);
  statusLight_1->setGateway(modbusBridge->getMudbus());
#else
  statusLight_0, statusLight_1 = NULL;
#endif
 
#ifdef HAS_FEED_SERVO
  if (stepperController_0)
  {
    setExtruderFeed(stepperController_0);
  }
#endif
 
  _state = APP_STATE::RESET;
  _error = E_OK;
 
  App::setup();
  registerComponents(bridge);
  onRegisterMethods(bridge);
 
  STATUS_ERROR_ON;
  STATUS_ERROR_BLINK;
  STATUS_WARNING_ON;
  STATUS_WARNING_BLINK;
  delay(500);
  STATUS_ERROR_OFF;
  STATUS_WARNING_OFF;
  STATUS_ERROR_BLINK_OFF;
  STATUS_WARNING_BLINK_OFF;
 
  print(0, 0);
 
#ifdef PRINT_MODBUS_REGISTERS
  printRegisters();
#endif
 
#ifdef MB_RELAY_0
  relay_0->set(MB_RELAY_0_DEFAULT);
#endif
 
#ifdef MB_RELAY_1
  relay_1->set(MB_RELAY_1_DEFAULT);
#endif
 
#if defined(HAS_FEED_SERVO) && defined(MB_RW_FEED_VFD_DEFAULT_SPEED_RATIO)
  modbusBridge->mb->R[MB_W_FEED_VFD_RATIO] = MB_RW_FEED_VFD_DEFAULT_SPEED_RATIO;
#endif
 
  return E_OK;
}

Member Data Documentation

_cstate

short PHApp::_cstate

Definition at line 101 of file PHApp.h.

_error

short PHApp::_error

Definition at line 102 of file PHApp.h.

_state

short PHApp::_state

Definition at line 100 of file PHApp.h.

com_serial

SerialMessage* PHApp::com_serial

Definition at line 61 of file PHApp.h.

comTS

millis_t PHApp::comTS

Definition at line 93 of file PHApp.h.

extruderFeed

StepperController* PHApp::extruderFeed

Definition at line 89 of file PHApp.h.

loopTS

millis_t PHApp::loopTS

Definition at line 94 of file PHApp.h.

mLoad

MotorLoad* PHApp::mLoad

Definition at line 85 of file PHApp.h.

modbusBridge

ModbusBridge* PHApp::modbusBridge

Definition at line 84 of file PHApp.h.

omronVFD

OmronVFD* PHApp::omronVFD

Definition at line 86 of file PHApp.h.

pids

OmronPID* PHApp::pids

Definition at line 87 of file PHApp.h.

pos3Analog_0

Pos3Analog* PHApp::pos3Analog_0

Definition at line 75 of file PHApp.h.

pos3Analog_1

Pos3Analog* PHApp::pos3Analog_1

Definition at line 76 of file PHApp.h.

pot_0

POT* PHApp::pot_0

Definition at line 62 of file PHApp.h.

pot_1

POT* PHApp::pot_1

Definition at line 63 of file PHApp.h.

pot_2

POT* PHApp::pot_2

Definition at line 64 of file PHApp.h.

relay_0

Relay* PHApp::relay_0

Definition at line 66 of file PHApp.h.

relay_1

Relay* PHApp::relay_1

Definition at line 67 of file PHApp.h.

relay_2

Relay* PHApp::relay_2

Definition at line 68 of file PHApp.h.

relay_3

Relay* PHApp::relay_3

Definition at line 69 of file PHApp.h.

relay_4

Relay* PHApp::relay_4

Definition at line 70 of file PHApp.h.

relay_5

Relay* PHApp::relay_5

Definition at line 71 of file PHApp.h.

relay_6

Relay* PHApp::relay_6

Definition at line 72 of file PHApp.h.

relay_7

Relay* PHApp::relay_7

Definition at line 73 of file PHApp.h.

statusLight_0

StatusLight* PHApp::statusLight_0

Definition at line 81 of file PHApp.h.

statusLight_1

StatusLight* PHApp::statusLight_1

Definition at line 82 of file PHApp.h.

stepperController_0

StepperController* PHApp::stepperController_0

Definition at line 78 of file PHApp.h.

stepperController_1

StepperController* PHApp::stepperController_1

Definition at line 79 of file PHApp.h.

timer

Timer<10, millis> PHApp::timer

Definition at line 97 of file PHApp.h.

wait

millis_t PHApp::wait

Definition at line 95 of file PHApp.h.

waitTS

millis_t PHApp::waitTS

Definition at line 96 of file PHApp.h.

---

The documentation for this class was generated from the following files:

• PHApp.h
• PHApp.cpp