weAut_01 / weAutSys    R 2.2.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines
Defines | Functions | Variables
HMI elements
+ + Process I/O and HMI functions + +

Overview

Human machine interface (HMI) here we mean display and control elements on the device visible and controllable for a person in front of it — and not the observing and controlling functions provided via serial and/or Ethernet communication links to locations more or less remote from the device.

weAut_01 (weAutSys' main target hardware) has

All other (14 red, green, blue) LEDs are directly linked to digital output and supply voltage state without any extra influence of the software.


Defines

#define enterKeyPressed(X)
 Enter key is (stable) pressed.
#define enterKeyRel(X)
 Enter key is released.
#define enterKeyReleased(X)
 Enter key is (stable) released.

Functions

uint8_t actDiLEDs (void) __attribute__((always_inline))
 DI display LEDs: actual value.
void offDiLEDs (void) __attribute__((always_inline))
 Turn DI display LEDs off.
void onDiLEDs (void) __attribute__((always_inline))
 Turn DI display LEDs on.
uint8_t prvDiLEDs (void) __attribute__((always_inline))
 DI display LEDs: previous value.
void toDiLEDs (uint8_t value)
 Output to DI display LEDs.

Variables

uint8_t pbFil
 Filtered Port B input.

Define Documentation

#define enterKeyRel (   X)

Enter key is released.

This is the direct un-filtered state of the enter button (weAut_01).
0 (false) is returned if the button is pressed.
Non 0 is returned if the enter button is released.

On the weAut_01 board the button nearer to the Ethernet and serial connectors is (hard) reset). The one more far away is the "enter" button handled here.

Configurations without that key always return non 0 (true).

#define enterKeyReleased (   X)

Enter key is (stable) released.

This is the filtered state of the enter key (weAut_01).
0 (false, OFF) is returned if the key is pressed.
Non 0 is returned if the enter key is released.

Configurations without that key always return 1 (non 0).

See also:
enterKeyPressed
Examples:
main.c.
#define enterKeyPressed (   X)

Enter key is (stable) pressed.

This is the filtered state of the enter key (weAut_01) .
Non 0 (true, ON) is returned if the key is released.
0 (false, OFF) is returned if the enter key is pressed.

Configurations without that key always return 0.

See also:
enterKeyReleased
Examples:
main.c.

Function Documentation

void toDiLEDs ( uint8_t  value)

Output to DI display LEDs.

This function outputs an eight bit value to the process digital input (DI) status LEDs.

On weAut_01 (weAut_00) this is the complete SPI 1 output function to the DI-LED driver for its 8 green status LEDs (in neighborhood of the DI clamps).

Hint: Using the SPI interface is avoided if the result can be obtained by output enabling / disabling the LED driver. This (doubtful) optimisation allows (regular) blinking even if the SPI interface is blocked for other operations. This feature may be removed in later hardware versions.

On other platforms (arduMega2560 and the like) the value will be output to an eight bit port configured therefore. If no DI-LED port is configured (DI_LEDs0_PORT undefined) no output will be done (but the states are hold).

Parameters:
value8 bits for 8 green LEDs, upper row, located same column as the corresponding DI clamps
See also:
toDOdriver
uint8_t actDiLEDs ( void  )

DI display LEDs: actual value.

This function returns the actual value of the DI LEDs.

See also:
toDiLEDs()
uint8_t prvDiLEDs ( void  )

DI display LEDs: previous value.

This function returns the actual value of the DI LEDs.

See also:
toDiLEDs()
void offDiLEDs ( void  )

Turn DI display LEDs off.

If the LEDs are off (==0) nothing is done.
If at least one is on this is a shorter equivalent for toDiLEDs(0).

See also:
toDiLEDs
onDiLEDs
void onDiLEDs ( void  )

Turn DI display LEDs on.

If not all LEDs are off (!=0) nothing is done.
If they are off this function is a (quick) equivalent for toDiLEDs( prvDiLEDs()).

See also:
offDiLEDs

Variable Documentation

uint8_t pbFil

Filtered Port B input.

Port B0 == 1 means enter key on (weAut_01) is released.

See also:
enterKeyReleased
enterKeyPressed