PLCnext API Documentation  21.0.0.35466
Public Types | Public Member Functions | Static Public Member Functions | List of all members
Arp::Device::Interface::Services::IDeviceControlService Class Referenceabstract

Use this service to control the device. More...

#include <IDeviceControlService.hpp>

Inheritance diagram for Arp::Device::Interface::Services::IDeviceControlService:
Inheritance graph

Public Types

typedef std::shared_ptr< IDeviceControlServicePtr
 
- Public Types inherited from Arp::System::Rsc::Services::IRscService
typedef std::shared_ptr< IRscServicePtr
 

Public Member Functions

 IDeviceControlService (void)
 Constructs an IDeviceControlService instance. More...
 
virtual ~IDeviceControlService (void)
 Destructs this instance and frees all resouces. More...
 
virtual void RestartDevice ()=0
 Reboot the device More...
 
virtual AccessErrorCode ResetToFactoryDefaults (uint16 resetType)=0
 Reset device configuration More...
 
virtual AccessErrorCode StartFirmwareUpdate (uint16 updateType)=0
 Start FW update More...
 
- Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
 IRscService (void)=default
 Constructs an IRscService instance. More...
 
virtual ~IRscService (void)=default
 Destructs this instance and frees all resouces. More...
 

Static Public Member Functions

static IRscServiceProxyFactory & GetProxyFactory (void)
 
- Static Public Member Functions inherited from Arp::System::Rsc::Services::IRscService
static IRscServiceProxyFactory & GetProxyFactory (void)
 Returns a reference to service proxy factory to create a proxy instance of the service More...
 

Detailed Description

Use this service to control the device.

Constructor & Destructor Documentation

◆ IDeviceControlService()

IDeviceControlService::IDeviceControlService ( void  )
inline

Constructs an IDeviceControlService instance.

◆ ~IDeviceControlService()

IDeviceControlService::~IDeviceControlService ( void  )
inlinevirtual

Destructs this instance and frees all resouces.

Member Function Documentation

◆ ResetToFactoryDefaults()

virtual AccessErrorCode Arp::Device::Interface::Services::IDeviceControlService::ResetToFactoryDefaults ( uint16  resetType)
pure virtual

Reset device configuration

Parameters
resetType1 Reset device configuration to factory default, 2 Downgrade FW to factory version and reset configuration
Returns
Result of start execute Arp.Device.Interface.Services.AccessErrorCode

After successfull start the PLC will stop and than reboot. While the reboot the requested defaults will be set.

◆ RestartDevice()

virtual void Arp::Device::Interface::Services::IDeviceControlService::RestartDevice ( )
pure virtual

Reboot the device

◆ StartFirmwareUpdate()

virtual AccessErrorCode Arp::Device::Interface::Services::IDeviceControlService::StartFirmwareUpdate ( uint16  updateType)
pure virtual

Start FW update

Parameters
updateTypeReserved for extentions, must be 0 in this version.
Returns
Result of start execute Arp.Device.Interface.Services.AccessErrorCode

Before you can start an update a raucb-container must be copied to path "/opt/plcnext". After successfull start an update the PLC will stop, execute the update and than reboot.


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