Component: Event Log (Runtime Tools)
| Author | Matrix TSL |
| Version | 1.0 |
| Category | Runtime Tools |
Event Log component
A simulation component designed to create a simple log record of events in your SCADA system. Logs to a file and / or to a console tab including optional automated time stamp.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable macro reference
|
LogEvent |
| Allows an event string to be logged | |
 - STRING
|
LogString |
 - VOID
|
Return |
|
|
GetTextLine |
| Gets the string data from a specific line in the console. | |
| [[File:]] - | Line |
| Line number, -1 for the last line. | |
| - STRING
|
Return |
|
|
PWMDisable |
| Disable a PWM output | |
 - BYTE
|
Channel |
| Range: 0-1 | |
| - VOID
|
Return |
|
|
I2CStart |
| Put the I2C Module into Start mode | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - I2C Bus Count - 1 | |
| - VOID
|
Return |
|
|
SPITransfer |
| Transfer a byte using the SPI bus | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - SPI Bus Count - 1 | |
| - BYTE
|
DataOut |
| - BYTE
|
Return |
|
|
I2CReceive |
| Receive a byte using the I2C bus | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - I2C Bus Count - 1 | |
| [[File:]] - | Last |
| Last byte to receive: Range 0-1 | |
| - BYTE
|
Return |
|
|
I2CStop |
| Put the I2C Module into Stop mode | |
| - BYTE
|
Channel |
| - VOID
|
Return |
|
|
WIFISetSSID |
| Assign the SSID and password for the network you wish to connect the board to. Stores the parameters into ROM for later USB free setup. | |
| - STRING
|
SSID |
| Name of the network you wish to connect to | |
| - STRING
|
Password |
| - VOID
|
Return |
|
|
ServoDisable |
| Disable a Servo output | |
| - BYTE
|
Channel |
| Range: 0-5 | |
| - VOID
|
Return |
|
|
SPIPrescaler |
| Modify the speed of the SPI bus | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - SPI Bus Count - 1 | |
| - BYTE
|
Prescaler |
| Range: 0-2 | |
| - VOID
|
Return |
|
|
ServoEnable |
| Enable a Servo output | |
| - BYTE
|
Channel |
| Range: 0-5 | |
| - VOID
|
Return |
|
|
ADCSample10 |
| Reads the voltage present on an Alanog pin as an 10-bit value range 0-1023 | |
| - BYTE
|
ADCChannel |
| Range: 0-5 | |
 - UINT
|
Return |
|
|
I2CTransSend |
| Sends an I2C Transaction on the selected I2C channel. Returns the number of bytes sent. | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - I2C Bus Count - 1 | |
| - BYTE
|
Data |
| Data to send | |
| - UINT
|
Count |
| Number of bytes to send out, MS bit 0x8000 signifies no Stop if set | |
| - UINT
|
Return |
|
|
I2CTransInit |
| Initialises the I2C Transaction mode with the 7-bit device address | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - I2C Bus Count - 1 | |
| - BYTE
|
DeviceAddress |
| 7-bit Device Address | |
| - BYTE
|
Baud |
| 0=100KHz, 1=400KHz, 2=1MHz | |
| - VOID
|
Return |
|
|
IOSetOutputPin |
| Sets the selected digital pin to an output and assigns the output state. | |
| - BYTE
|
Pin |
| Range: 0-17 | |
| [[File:]] - | State |
| Range: 0-1 | |
| - VOID
|
Return |
|
|
ServoSetPosition8 |
| Sets the position as an 8-bit value | |
| - BYTE
|
Channel |
| Range: 0-1 | |
| - BYTE
|
Position |
| Range: 0-255 | |
| - VOID
|
Return |
|
|
UARTReceive |
| Receives a data byte from the UART. Recommend calling the UARTCheckRx function first to ensure data is available. | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - UART Bus Count - 1 | |
| - BYTE
|
Return |
|
|
SPIInitialise |
| Initialsie the SPI module ready for communications | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - SPI Bus Count - 1 | |
| - VOID
|
Return |
|
|
WIFIGetIP |
| Gets the IP address of the board. Allows you to setup and get the assigned address via USB before using over WIFI, Use the WIFIIsConnected first to check the WIFI is active. | |
| - STRING
|
Return |
|
|
I2CSend |
| Transmit a byte using the I2C bus | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - I2C Bus Count - 1 | |
| - BYTE
|
DataOut |
| [[File:]] - | Return |
|
|
UARTSend |
| Send a byte via the UART module | |
| - BYTE
|
Channel |
| Channel Index: Range 0 - UART Bus Count - 1 | |
| - BYTE
|
Data |
| Data Byte to send. Range: 0-255 | |
| - VOID
|
Return |
|
|
PWMSetPrescaler |
| Sets the prescaler for the PWM output | |
| - BYTE
|
Prescaler |
| - VOID
|
Return |
|
|
PWMSetDuty8 |
| Sets the duty for the PWM output | |
| - BYTE
|
Channel |
| Range: 0-1 | |
| - BYTE
|
Duty |
| Range: 0-255 | |
| - VOID
|
Return |
|
|
PWMEnable |
| Enable a PWM output | |
| - BYTE
|
Channel |
| Range: 0-1 | |
| - VOID
|
Return |
|
|
Initialise |
| Initialise the comms to the Arduino board ready for commands to be sent. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Log To Console |
|
|
Log To File |
|
|
Include Timestamp |
| Controls if a timestamp is appended to the start of the log string. Yes: Add timestamp to log string No: Leave log string as is | |
|
Console Name |
|
|
Clear On Init |
| Selects if the contents of the console are maintained or wiped on runtime start. Yes: Console is automatically cleared No: Console is maintained and appended | |
|
Log File |
| File to store the log data. Default: $(srcdir)log.txt $(srcdir) specifies the directory containing your Flowcode project file. log.txt specifies a file named log.txt If the file does not exist then it will be automatically created for you. | |
|
|
Clear On Init |
| Selects if the contents of the log file are maintained or wiped on runtime start. Yes: Log file is automatically cleared No: Log file is maintained and appended | |
|
TimeStamp |
|
|
US Date Format |
| Specifies the format of the date string. No - "DD/MM/YY" Yes - "MM/DD/YY" | |
|
Connections |
|
|
Simulations |