Author
|
Matrix TSL
|
Version
|
1.0
|
Category
|
Indicators
|
Logo Indicator component
A simple component to display multiple icons relating to the state of a machine or process. Includes icons such as: tick, cross, alert, stop, go and coloured lights.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable macro reference
|
AssignLogo
|
Sets the logo displayed on the indicator.
|
- BYTE
|
LogoIdx
|
Logo Index: 1=Tick, 2=Cross, 3=Exclamation, 4=Green, 5=Amber, 6=Red, 7=Stop, 8=Go
|
- VOID
|
Return
|
|
SetRange
|
Set the minimum and maximum values of the scale
|
[[File:]] -
|
Minimum
|
Minimum value for the scale
|
[[File:]] -
|
Maximum
|
Maximum value for the scale
|
- VOID
|
Return
|
|
ReadByteFromIndex
|
Reads an arbitrary byte of data from the current open file. Return = Data byte read from the local sector buffer. Experimental and potentially slow if navigating backwards through the file.
|
- ULONG
|
Address
|
Contains the position of the byte to be read from the file
|
- BYTE
|
Return
|
|
CreateFile
|
Creates a file in the current folder location on the card. Default = Root Returns 0 for success File must be opened using "Open_File" after creation before writing any data.
|
- STRING
|
Filename
|
8.3 format filename e.g."file.txt"
|
- BYTE
|
Return
|
|
ScanCurrentFolder
|
Method for retreiving file or folder names for the card to allow for dynamic file opening or playback. Does not currently simulate. 0 - Filetype found and stored into string array, 1 - End of folder reached, 2 - Filetype mismatch 3 - Empty
|
- UINT
|
Current_Idx
|
Contains the current pointer in the directory table. Values from 0 to 511 to completley search the current folder for a files or folders
|
- BYTE
|
Scan_Type
|
Sets the scan to search for Files or Folders. 0 = Scan for files, 1 = Scan for folders
|
- BYTE
|
Return
|
|
ReadByteFromScan
|
Returns a byte of the name of the file or folder retreived from the Scan_Current_folder function. Return = ASCII byte at position Idx from the folder name or file name at position Current_Idx in the directory
|
- BYTE
|
idx
|
0 - 11 for a file, 0 - 7 for a folder
|
- BYTE
|
Return
|
|
OpenFolder
|
".." - Jumps up a directory, if at root then remains in root "root" - Jumps directly back to the root directory "foldername" - Opens folder named foldername
|
- STRING
|
Folder_Name
|
|
- BYTE
|
Return
|
|
ReadByteFromBuffer
|
Reads a byte of data from the local sector buffer. Return = Data byte read from the local sector buffer.
|
- UINT
|
Address
|
0 - 511 - Contains the position of the byte to be read
|
- BYTE
|
Return
|
|
ReadFileLength
|
Returns the number of bytes in the current sector that are used by the current open file. Return = 512 - Sector is filled with file data Return < 512 - Last sector of the file, Retval specifies how many bytes of data are remaining in the sector
|
[[File:]] -
|
Return
|
|
OpenFile
|
Searches for and opens a file for reading or writing from within the current directory on the disk. Returns 0 for success.
|
- STRING
|
Filename
|
8.3 filename of the file we are trying to open e.g. "file.txt"
|
- BYTE
|
Return
|
|
WriteFileSector
|
Overwrites the current sector on the memory card with the contents of the local sector buffer. See write_byte_to_buffer function. Return = 0 - File sector written successfully. Return > 0 - File sector write error
|
- BYTE
|
Return
|
|
SetFileIndex
|
Sets the current file index and used to switch between several open file streams. Default = 0.
|
- BYTE
|
File_Index
|
File index ranges from 0 to (Max Concurrent Files - 1)
|
- VOID
|
Return
|
|
AppendStringToFile
|
Adds the contents of the data string parameter to the end of the currently open file. Returns 0 for success.
|
- STRING
|
Data_String
|
Data to append to the end of the file
|
- BYTE
|
Return
|
|
ReadFileSize
|
Reads the entire size of the current file in bytes.
|
- ULONG
|
Return
|
|
SetTimeAndDate
|
Sets the current time and date. Time = (Hour << 11) + (Min << 5) + (Sec >> 1) Date = (YearFrom1980 << 9) + (Month << 5) + (Day) Additional details can be found here: http://www.maverick-os.dk/FileSystemFormats/FAT16_FileSystem.html#TimeFormat
|
- UINT
|
Time
|
Sets the current Time in FAT Time format hhhhhmmmmmmsssss - S=Secs/2
|
- UINT
|
Date
|
Sets the current Date in FAT Date format yyyyyyymmmmddddd - Y=Years since 1980
|
- VOID
|
Return
|
|
Initialise
|
Attempts to communicate with the SD card and if successful sets up the file system. Returns 0 for success.
|
- BYTE
|
Return
|
|
Initialise
|
Initialise the comms to the Arduino board ready for commands to be sent.
|
- VOID
|
Return
|
|
PWMEnable
|
Allows pulse width modulated transistor outputs to be switched on or off. Bit 0 = Enable AB Bit 1 = A / Bit 2 = B Bit 3 = C / Bit 4 = D Bit 5 = Enable CD
|
- BYTE
|
EnableMask
|
Range 0-63 or 0b00000 to 0b111111
|
- VOID
|
Return
|
|
Initialise
|
|
- VOID
|
Return
|
|
LCDClear
|
Clears the MIAC display
|
- VOID
|
Return
|
|
LCDClear
|
Clears the LCD
|
- VOID
|
Return
|
Property reference
|
Properties
|
|
Default Icon
|
Icon that is automatically loaded when starting the runtime or reopening the project. The Don't Modify setting will leave the icon in it's last written state.
|
|
Show Title
|
Decides if the component title is shown
|
|
Title Colour
|
Title Label Color
|
|
Title Text
|
Title Label Text
|
|
Title Scale
|
Controls the size of the title text on the panel, default 1.2
|
|
Title Offset
|
Distance above component center to draw the title
|
|
Connections
|
|
Simulations
|