HW_V4 Class Reference

Driver for the Nuclear Instruments V4 Hardware Board. More...

#include <fw_board_ni_v4.h>

Inheritance diagram for HW_V4:

Collaboration diagram for HW_V4:

Public Member Functions
bool	Init ()
	Initialize hardware peripheral in the system. More...
bool	I2CWrite (t_i2cdevices device, uint8_t *wbuffer, int wlength, bool stop)
	Write buffer to I2C bus. More...
bool	I2CRead (t_i2cdevices device, uint8_t *wbuffer, int wlength, uint8_t *rbuffer, int rlength, bool stop)
	Write buffer to I2C bus and read data. More...
bool	I2CRead (t_i2cdevices device, uint8_t *rbuffer, int rlength, bool stop)
	Read I2c data. More...
bool	PWMSet (hw_pwm id, float value)
	Control PWM device (PV1) More...
bool	IOSet (hw_gpio id, bool value)
	Set a GPIO Status (IE Control PV6, Alarms, etc) More...
bool	IOGet (hw_gpio id, bool *value)
	Get GPIO Status. More...
void	PrintDebugConsole (String s)
	Print a message on console used for Debug. More...
void	PrintLineDebugConsole (String s)
	Print a message on console used for Debug with a CR+LR at end. More...
void	Tick ()
	Tick function must be called periodically. More...
bool	DataAvailableOnUART0 ()
	API to read if on the communication interfaces there are bytes to be read. More...
String	ReadUART0UntilEOL ()
	Return a terminated string from communication interface. More...
bool	WriteUART0 (String s)
	API to write a string to the communication interfaces. More...
void	GetPowerStatus (bool *batteryPowered, float *charge)
	API to read battery charge and power supply status. More...
float	GetPIN ()
	API return pressure on input of MVM. More...
float	GetBoardTemperature ()
	API return temperature of the board. More...
uint16_t	GetSupervisorAlarms ()
	API return Supervisor managed alarms. More...

Private Member Functions
void	__service_i2c_detect ()
	Detect all I2C devices on bus. More...
void	i2c_MuxSelect (uint8_t i)
	Switch I2C multiplexer. More...
t_i2cdev	GetIICDevice (t_i2cdevices device)
	Search in the iic_devs list a particular device and return descriptor. More...
uint16_t	ReadSupervisor (uint8_t i_address)
	Read a supervisor register. More...
void	WriteSupervisor (uint8_t i_address, uint16_t write_data)
	Write a supervisor register. More...

Private Attributes
bool	EnableWatchdogSupervisor = true
t_i2cdev	iic_devs [IIC_COUNT]
uint8_t	current_muxpos = 10
uint64_t	batteryStatus_reading_LT
float	currentBatteryCharge
bool	pWall
float	pIN
float	BoardTemperature
uint16_t	HW_AlarmsFlags

Detailed Description

Driver for the Nuclear Instruments V4 Hardware Board.

Definition at line 23 of file fw_board_ni_v4.h.

Member Function Documentation

__service_i2c_detect()

void HW_V4::__service_i2c_detect ( )

private

Detect all I2C devices on bus.

Definition at line 506 of file fw_board_ni_v4.cpp.

{
    byte error, address;
    int nDevices;
    Serial.println("Scanning... I2C");
    nDevices = 0;
    for (address = 1; address < 127; address++) {
        Wire.beginTransmission(address);
        error = Wire.endTransmission();
        if (error == 0) {
            Serial.print("I2C device found at address 0x");
            if (address < 16) {
                Serial.print("0");
            }
            Serial.println(address, HEX);
            nDevices++;
        }
        else if (error == 4) {
            Serial.print("Unknow error at address 0x");
            if (address < 16) {
                Serial.print("0");
            }
            Serial.println(address, HEX);
        }
    }
    if (nDevices == 0) {
        Serial.println("No I2C devices found\n");
    }
    else {
        Serial.println("done\n");
    }
}

Here is the call graph for this function:

DataAvailableOnUART0()

bool HW_V4::DataAvailableOnUART0

(

)

API to read if on the communication interfaces there are bytes to be read.

Returns

true if bytes are available

Definition at line 452 of file fw_board_ni_v4.cpp.

{
    return Serial.available();
}

Here is the caller graph for this function:

GetBoardTemperature()

float HW_V4::GetBoardTemperature

(

)

API return temperature of the board.

Returns

temperature in °C

Definition at line 633 of file fw_board_ni_v4.cpp.

{
    return BoardTemperature;
}

Here is the caller graph for this function:

GetIICDevice()

t_i2cdev HW_V4::GetIICDevice ( t_i2cdevices  device )

private

Search in the iic_devs list a particular device and return descriptor.

Parameters

device

device (t_i2cdevices) to be searched for

Returns

device handler

Definition at line 570 of file fw_board_ni_v4.cpp.

{
    for (int i = 0; i < IIC_COUNT; i++)
    {
        if (iic_devs[i].t_device == device)
        {
            return iic_devs[i];
        }
    }
}

Here is the caller graph for this function:

GetPIN()

float HW_V4::GetPIN

(

)

API return pressure on input of MVM.

Returns

pressure in mbar

Definition at line 623 of file fw_board_ni_v4.cpp.

{
    return pIN;
}

Here is the caller graph for this function:

GetPowerStatus()

void HW_V4::GetPowerStatus	(	bool *	batteryPowered,
		float *	charge
	)

API to read battery charge and power supply status.

Parameters

batteryPowered	true the system is battery powered false the system is powered from 220v
charge	% of battery charge

Definition at line 438 of file fw_board_ni_v4.cpp.

{
    *batteryPowered = pWall ? false:true;
    *charge = currentBatteryCharge ;
 
}

Here is the caller graph for this function:

GetSupervisorAlarms()

uint16_t HW_V4::GetSupervisorAlarms

(

)

API return Supervisor managed alarms.

    bit 0 : input pressure too low
    bit 1 : input pressure too high
    bit 2 : board temperature too low
    bit 3 : board temperature too high
    bit 4 : no activity on the valves
    bit 5 : power regulator issue
    bit 6 : battery charge critical

Returns

encoded alarm status

Definition at line 652 of file fw_board_ni_v4.cpp.

{
    return HW_AlarmsFlags;
}

Here is the caller graph for this function:

i2c_MuxSelect()

void HW_V4::i2c_MuxSelect ( uint8_t  i )

private

Switch I2C multiplexer.

Check if mux is already in the correct position otherwise commutate

Parameters

i

Definition at line 546 of file fw_board_ni_v4.cpp.

{
    if (i > 7)
        return;
 
    if (i < 0)
        return;
 
    if (current_muxpos == i) return;
 
    current_muxpos = i;
 
    Wire.beginTransmission(TCAADDR);
    Wire.write(1 << i);
    Wire.endTransmission();
    delayMicroseconds(500);
}

Here is the caller graph for this function:

I2CRead() [1/2]

bool HW_V4::I2CRead	(	t_i2cdevices	device,
		uint8_t *	rbuffer,
		int	rlength,
		bool	stop
	)

Read I2c data.

This function also switch mux port in order to access to required device

Parameters

device	name of the device listened in the iic_dev (t_i2cdevices)
rbuffer	reading buffer (should be allocated externally)
rlength	number of bytes to be read
stop	add stop at end of transaction

Returns

true if success

Definition at line 227 of file fw_board_ni_v4.cpp.

{
    uint8_t count;
    uint8_t address;
    t_i2cdev dev = GetIICDevice(device);
    address = dev.address;
    i2c_MuxSelect(dev.muxport);
 
    count = Wire.requestFrom((uint16_t)address, (uint8_t)rlength, stop);
 
    if (count < rlength)
        return false;
 
 
    for (int i = 0;i < rlength; i++)
    {
        rbuffer[i] = Wire.read();
    }
 
    return true;
}

Here is the call graph for this function:

I2CRead() [2/2]

bool HW_V4::I2CRead	(	t_i2cdevices	device,
		uint8_t *	wbuffer,
		int	wlength,
		uint8_t *	rbuffer,
		int	rlength,
		bool	stop
	)

Write buffer to I2C bus and read data.

This function also switch mux port in order to access to required device

Parameters

device	name of the device listened in the iic_dev (t_i2cdevices)
wbuffer	buffer to be written
wlength	length of the buffer to be written
rbuffer	reading buffer (should be allocated externally)
rlength	number of bytes to be read
stop	add stop at end of transaction

Returns

true if success

Definition at line 182 of file fw_board_ni_v4.cpp.

{
    uint8_t address;
    uint8_t count;
    uint8_t result;
 
    //Search I2C device by name
    t_i2cdev dev = GetIICDevice(device);
    address = dev.address;
 
    //Switch multiplexer
    i2c_MuxSelect(dev.muxport);
 
    //Arduino I2C Write operation
    Wire.beginTransmission(address);
    for (int i = 0;i < wlength; i++)
        Wire.write(wbuffer[i]);
    result = Wire.endTransmission();
    if (result != 0)
        return false;
 
    //Arduino I2C Read operation
    count = Wire.requestFrom((uint16_t)address, (uint8_t)rlength, stop);
    if (count < rlength)
        return false;
 
    for (int i = 0;i < rlength; i++)
    {
        rbuffer[i] = Wire.read();
    }
 
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

I2CWrite()

bool HW_V4::I2CWrite	(	t_i2cdevices	device,
		uint8_t *	wbuffer,
		int	wlength,
		bool	stop
	)

Write buffer to I2C bus.

This function also switch mux port in order to access to required device

Parameters

device	name of the device listened in the t_i2cdevices iic_dev
wbuffer	buffer to be written
wlength	length of the buffer
stop	add stop bit at end of transaction

Returns

true if success

Definition at line 145 of file fw_board_ni_v4.cpp.

{
    uint8_t address;
    uint8_t result;
    
    //Search I2C device by name
    t_i2cdev dev = GetIICDevice(device);
    address = dev.address;
 
    //Switch multiplexer
    i2c_MuxSelect(dev.muxport);
 
    //Arduino I2C Write operation
    Wire.beginTransmission(address);
    for (int i = 0;i < wlength; i++)
        Wire.write(wbuffer[i]);
    result = Wire.endTransmission();
 
    if (result != 0)
        return false;
    else
        return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Init()

bool HW_V4::Init

(

)

Initialize hardware peripheral in the system.

The function configure:

• Serial Port
• PWM
• PINS
• I2C
• Initialize the device list iic_devs
• Variables

It also perform a I2C scan

Returns

Definition at line 36 of file fw_board_ni_v4.cpp.

{
 
    //Init serial port 115200,8,n,1
    Serial.begin(115200);
 
    //Init PWM for PV1, 10KHz, 12 bit
    ledcSetup(0, 10000, 12);
    ledcAttachPin(VALVE_IN_PIN, 0);
    ledcWrite(0, 0);
 
    //Init pins: PV2, ALARM LED, BUZZER, RELE
    digitalWrite(VALVE_OUT_PIN, LOW);
    digitalWrite(ALARM_LED, LOW);
    digitalWrite(BUZZER, LOW);
    digitalWrite(ALARM_RELE, HIGH);
 
    pinMode(VALVE_OUT_PIN, OUTPUT);
    pinMode(ALARM_LED, OUTPUT);
    pinMode(BUZZER, OUTPUT);
    pinMode(ALARM_RELE, OUTPUT);
 
    //Start I2C Master and Scan bus
    Wire.begin();
 
    for (int i = 0; i < 8; i++) {
        i2c_MuxSelect(i);
        Serial.println("SCAN I2C BUS: " + String(i));
        __service_i2c_detect();
    }
 
    //Init list of devices on I2C bus
 
    iic_devs[0].t_device = IIC_PS_0;            //NAME OF THE SENSORE
    iic_devs[0].muxport = 0;                    //Multiplexer PORT
    iic_devs[0].address = 0x76;                 //I2C ADDRESS
 
    iic_devs[1].t_device = IIC_PS_1;
    iic_devs[1].muxport = 0;
    iic_devs[1].address = 0x77;
 
    iic_devs[2].t_device = IIC_PS_2;
    iic_devs[2].muxport = 1;
    iic_devs[2].address = 0x76;
 
#ifdef USE_SPIROMETER_SFM3019
    iic_devs[3].t_device = IIC_FLOW1;
    iic_devs[3].muxport = 1;
    iic_devs[3].address = 0x2E;
 
#endif
 
#ifdef USE_SPIROMETER_SFM3000
    iic_devs[3].t_device = IIC_FLOW1;
    iic_devs[3].muxport = 1;
    iic_devs[3].address = 0x40;
#endif
 
    iic_devs[4].t_device = IIC_ADC_0;
    iic_devs[4].muxport = 4;
    iic_devs[4].address = 0x48;
 
    iic_devs[5].t_device = IIC_SUPERVISOR;
    iic_devs[5].muxport = 3;
    iic_devs[5].address = 0x22;
 
 
    iic_devs[6].t_device = IIC_MUX;
    iic_devs[6].muxport = -1;
    iic_devs[6].address = 0x70;
 
    iic_devs[7].t_device = IIC_GENERAL_CALL_SENSIRION;
    iic_devs[7].muxport = 1;
    iic_devs[7].address = 0x00;
 
 
    batteryStatus_reading_LT = GetMillis();
 
 
    currentBatteryCharge = 100;
    pWall=true;
    pIN=3;
    BoardTemperature=25;
    
    //init supervisor watchdog
 
    /*
    * During development we keep disabled supervisor watchdog
    * otherwise it will trigger low level alarm every time 
    * we reprogram ESP
    * 
    * 0 : DEVELOPMENT   - NO SUPERVISOR WATCHDOG
    * 1 : PRODUCTION    - ENABLE SUPERVISOR WATCHDOG
    */
 
    
}

Here is the call graph for this function:

Here is the caller graph for this function:

IOGet()

bool HW_V4::IOGet	(	hw_gpio	id,
		bool *	value
	)

Get GPIO Status.

Parameters

id	name of the GPIO (enum hw_gpio)
value	OUTPUT true: logic level HI, low: logic level LOW

Returns

true if GPIO exists

Definition at line 325 of file fw_board_ni_v4.cpp.

{
    switch (id)
    {
    case GPIO_PV2:
        *value = digitalRead(VALVE_OUT_PIN);
        break;
    case GPIO_BUZZER:
        *value = digitalRead(BUZZER);
        break;
    case GPIO_LED:
        *value = digitalRead(ALARM_LED);
        break;
    case GPIO_RELEALLARM:
        *value = digitalRead(ALARM_RELE);
        break;
    default:
        return false;
        break;
    }
    return true;
}

IOSet()

bool HW_V4::IOSet	(	hw_gpio	id,
		bool	value
	)

Set a GPIO Status (IE Control PV6, Alarms, etc)

Parameters

id	name of the GPIO (enum hw_gpio)
value	true: logic level HI, low: logic level LOW

Returns

true if GPIO exists

Definition at line 288 of file fw_board_ni_v4.cpp.

{
    switch (id)
    {
    case GPIO_PV2:
        digitalWrite(VALVE_OUT_PIN, value ? HIGH : LOW);
        /*
        * The breethe signal is used by the supervisor to check
        * whenever the driver for PV1 and PV2 is not working
        * We need to commutate breethe synchronous with PV2
        */
        if (value==LOW)
            digitalWrite(BREETHE, LOW);
        break;
    case GPIO_BUZZER:
        digitalWrite(BUZZER, value ? HIGH : LOW);
        break;
    case GPIO_LED:
        digitalWrite(ALARM_LED, value ? HIGH : LOW);
        break;
    case GPIO_RELEALLARM:
        digitalWrite(ALARM_RELE, value ? HIGH : LOW);
        break;
    default:
        return false;
        break;
    }
    return true;
}

Here is the caller graph for this function:

PrintDebugConsole()

void HW_V4::PrintDebugConsole

(

String

s

)

Print a message on console used for Debug.

For ESP32 this is the same console of interface bus this is dangerous and in production DEBUG LEVEL should be set in order to be sure that no debug message is forwarded on this console otherwise GUI will crash

Parameters

s	String to be print

Definition at line 368 of file fw_board_ni_v4.cpp.

{
    Serial.print(s);
}

Here is the call graph for this function:

PrintLineDebugConsole()

void HW_V4::PrintLineDebugConsole

(

String

s

)

Print a message on console used for Debug with a CR+LR at end.

For ESP32 this is the same console of interface bus this is dangerous and in production DEBUG LEVEL should be set in order to be sure that no debug message is forwarded on this console otherwise GUI will crash

Parameters

s	String to be print

Definition at line 384 of file fw_board_ni_v4.cpp.

{
    Serial.println(s);
}

Here is the call graph for this function:

Here is the caller graph for this function:

PWMSet()

bool HW_V4::PWMSet	(	hw_pwm	id,
		float	value
	)

Control PWM device (PV1)

Parameters

id	name of the device (enum hw_pwm)
value	value from 0 to 100

Returns

always true

Definition at line 256 of file fw_board_ni_v4.cpp.

{
 
    if ((value < 0) || (value > 100.0)) return false;
 
    switch (id)
    {
    case PWM_PV1:
        uint32_t v = (uint32_t)value * 4095.0 / 100.0;
        ledcWrite(0, v);
        /*
        * The breethe signal is used by the supervisor to check
        * whenever the driver for PV1 and PV2 is not working
        * We need to commutate breethe synchronous with PV1
        */
        if (v > 0)
            digitalWrite(BREETHE, HIGH);
        break;
 
    }
 
 
    return true;
}

Here is the caller graph for this function:

ReadSupervisor()

uint16_t HW_V4::ReadSupervisor ( uint8_t  i_address )

private

Read a supervisor register.

Parameters

i_address

address of the register in the supervisor register file

Returns

value of the register

Definition at line 587 of file fw_board_ni_v4.cpp.

{
    uint8_t wbuffer[4];
    uint8_t rbuffer[4];
        
    wbuffer[0] = i_address;
    I2CRead(IIC_SUPERVISOR, wbuffer, 1, rbuffer, 2, true);
 
    uint16_t a;
 
    a = (rbuffer [1]<< 8) | rbuffer[0];
    return a;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ReadUART0UntilEOL()

String HW_V4::ReadUART0UntilEOL

(

)

Return a
terminated string from communication interface.

Returns

Recevied string

Definition at line 474 of file fw_board_ni_v4.cpp.

{
    //PERICOLO. SE IL \n NON VIENE INVIATO TUTTO STALLA!!!!
    return Serial.readStringUntil('\n');
}

Here is the call graph for this function:

Here is the caller graph for this function:

Tick()

void HW_V4::Tick

(

)

Tick function must be called periodically.

The function performs in this driver polling task

Every seconds the function will contact the supervisor to do:

• read battery charge
• read power status (power line/battery)
• read input pressure
• read board temperature
• read supervisor alarm flags
• reset supervisor watchdog

Definition at line 403 of file fw_board_ni_v4.cpp.

{
    if (Get_dT_millis(batteryStatus_reading_LT)>1000)
    {
        batteryStatus_reading_LT = GetMillis();
        currentBatteryCharge = (float)ReadSupervisor(0x51);
        currentBatteryCharge = currentBatteryCharge < 0 ? 0 : currentBatteryCharge;
        currentBatteryCharge = currentBatteryCharge > 100 ? 100 : currentBatteryCharge;
        pWall = ReadSupervisor(0x52) >0 ? false : true ;
        pIN = ((float)ReadSupervisor(0x50));
        BoardTemperature = ((float)ReadSupervisor(0x56)/10.0);
        HW_AlarmsFlags = (uint16_t)ReadSupervisor(0x57);
 
        //reset supervisor watchdog
        WriteSupervisor(0x00, 1);
 
        if (EnableWatchdogSupervisor){
            WriteSupervisor(0x01, 1);
            EnableWatchdogSupervisor = false;
            }
        //Serial.println("Battery: " + String(currentBatteryCharge) + " PWALL: " + String (pWall));
    }
    
 
    return;
}

Here is the call graph for this function:

Here is the caller graph for this function:

WriteSupervisor()

void HW_V4::WriteSupervisor ( uint8_t  i_address, uint16_t  write_data  )

private

Write a supervisor register.

Parameters

i_address	address of the register in the supervisor register file
write_data	value of the register

Definition at line 607 of file fw_board_ni_v4.cpp.

{
    uint8_t wbuffer[4];
    wbuffer[0] = i_address;
    wbuffer[1] = write_data & 0xFF;
    wbuffer[2] = (write_data >> 8) & 0xFF;
 
    I2CWrite(IIC_SUPERVISOR, wbuffer, 3, true);
 
}

Here is the call graph for this function:

Here is the caller graph for this function:

WriteUART0()

bool HW_V4::WriteUART0

(

String

s

)

API to write a string to the communication interfaces.

Parameters

s	String to be written

Returns

always true

Definition at line 463 of file fw_board_ni_v4.cpp.

{
    Serial.println(s);
    return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

batteryStatus_reading_LT

uint64_t HW_V4::batteryStatus_reading_LT

private

Definition at line 63 of file fw_board_ni_v4.h.

BoardTemperature

float HW_V4::BoardTemperature

private

Definition at line 68 of file fw_board_ni_v4.h.

current_muxpos

uint8_t HW_V4::current_muxpos = 10

private

Definition at line 61 of file fw_board_ni_v4.h.

currentBatteryCharge

float HW_V4::currentBatteryCharge

private

Definition at line 64 of file fw_board_ni_v4.h.

EnableWatchdogSupervisor

bool HW_V4::EnableWatchdogSupervisor = true

private

Definition at line 51 of file fw_board_ni_v4.h.

HW_AlarmsFlags

uint16_t HW_V4::HW_AlarmsFlags

private

Definition at line 69 of file fw_board_ni_v4.h.

iic_devs

t_i2cdev HW_V4::iic_devs[IIC_COUNT]

private

Definition at line 60 of file fw_board_ni_v4.h.

pIN

float HW_V4::pIN

private

Definition at line 67 of file fw_board_ni_v4.h.

pWall

bool HW_V4::pWall

private

Definition at line 65 of file fw_board_ni_v4.h.

---

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

• fw_board_ni_v4.h
• fw_board_ni_v4.cpp