ST / X_NUCLEO_PLC01A1

Library to handle the X-NUCLEO-PLC01A1 Programmable Logic Controller Expansion Board based on the VNI8200XP (solid state relay) and CLT01-38SQ7 (octal digital termination array) components.

Dependents:   HelloWorld_PLC01A1

Embed: (wiki syntax)

« Back to documentation index

PLCInput Class Reference
Public Member Functions

PLCInput Class Reference

An abstract class for PLCInput component. More...

#include <PLCInput.h>

Inherits Component.

Inherited by CLT01_38S.

Public Member Functions

virtual uint8_t get_read_status (void)=0
 Get Read Status.
virtual void set_read_status (uint8_t status)=0
 Set Read Status.
virtual uint8_t get_input_data (void)=0
 Get Input Status.
virtual uint8_t over_temp_alarm (void)=0
 Over Temperature Alarm bit.
virtual uint8_t check_parity (void)=0
 Parity Check bits.
virtual uint8_t under_volt_alarm (void)=0
 Under Voltage Alarm bit.
virtual void dig_inp_array_get_input (uint8_t *inputArray)=0
 Get input information from input channels component.
virtual void set_input_spi (uint8_t l)=0
 Auxiliary method to enable or disable SPI CS pin.
virtual ~PLCInput ()
 Destructor.
virtual int init (void *init)=0
 Initializing the component.
virtual int read_id (uint8_t *id)=0
 Getting the ID of the component.

Detailed Description

An abstract class for PLCInput component.

Definition at line 55 of file PLCInput.h.

Constructor & Destructor Documentation

virtual ~PLCInput (  ) [virtual]

Destructor.

Definition at line 117 of file PLCInput.h.

Member Function Documentation

virtual uint8_t check_parity ( void   ) [pure virtual]

Parity Check bits.

Parameters:
None
Return values:
Paritybits for diagnosing inconsistency in data transmission

Implemented in CLT01_38S.

virtual void dig_inp_array_get_input ( uint8_t *  inputArray ) [pure virtual]

Get input information from input channels component.

Parameters:
RXbuffer
Return values:
None

Implemented in CLT01_38S.

virtual uint8_t get_input_data ( void   ) [pure virtual]

Get Input Status.

Parameters:
None
Return values:
Channelsstatus corresponding to 8 inputs

Implemented in CLT01_38S.

virtual uint8_t get_read_status ( void   ) [pure virtual]

Get Read Status.

Parameters:
None
Return values:
Status

Implemented in CLT01_38S.

virtual int init ( void *  init ) [pure virtual, inherited]

Initializing the component.

Parameters:
[in]initpointer to device specific initalization structure.
Return values:
0in case of success, an error code otherwise.

Implemented in CLT01_38S, and VNI8200XP.

virtual uint8_t over_temp_alarm ( void   ) [pure virtual]

Over Temperature Alarm bit.

Parameters:
None
Return values:
Overtemperaturebit, 1 in case of alarm

Implemented in CLT01_38S.

virtual int read_id ( uint8_t *  id ) [pure virtual, inherited]

Getting the ID of the component.

Parameters:
[out]idpointer to an allocated variable to store the ID into.
Return values:
0in case of success, an error code otherwise.

Implemented in CLT01_38S, and VNI8200XP.

virtual void set_input_spi ( uint8_t  l ) [pure virtual]

Auxiliary method to enable or disable SPI CS pin.

Parameters:
lflag to enable or disable SPI CS pin

Implemented in CLT01_38S.

virtual void set_read_status ( uint8_t  status ) [pure virtual]

Set Read Status.

Parameters:
Status
Return values:
None

Implemented in CLT01_38S.

virtual uint8_t under_volt_alarm ( void   ) [pure virtual]

Under Voltage Alarm bit.

Parameters:
None
Return values:
Undervoltage alarm bit, 1 in case of alarm

Implemented in CLT01_38S.

Generated on Fri Jul 15 2022 00:11:30 by  doxygen 1.7.2