Component: GLCD (SSD1306) SPI (SSD1306) (Graphical Monochrome)
From Flowcode Help
Jump to navigationJump to searchAuthor | Matrix TSL |
Version | 0.1 |
Category | Graphical Monochrome |
Contents
GLCD (SSD1306) SPI component
Graphical display component based on the SPI version of the SSD1306 monochrome graphical controller IC. Functions without the use of a read pin forcing the data to be written a byte at a time.
Detailed description
No detailed description exists yet for this component
Examples
The following files provide examples of how to use this component:
- This template allows users to quickly and simply get up and running with their hardware.
- The default microcontroller for this template board is the 32bit PIC32MX320F128H found
- on the Uno32 hardware.
- It features;
- 4x push-switch, 4x slide switch
- 8x LEDS, 1x Potentiometer
- 1x OLED Screen
Downloadable macro reference
SendCommand | |
- BYTE | Command |
- VOID | Return |
DrawLine | |
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2. | |
- UINT | X1 |
- UINT | Y1 |
- UINT | X2 |
- UINT | Y2 |
- VOID | Return |
Plot | |
Sets a pixel with the current foreground colour at pixel location X, Y. | |
- UINT | X1 |
- UINT | Y1 |
- VOID | Return |
ControlDisplay | |
Allows the display to be switched on and off | |
- BYTE | Control |
0=Off, 1=On | |
- VOID | Return |
SendData | |
- BYTE | Byte |
- VOID | Return |
BPlot | |
Sets a pixel with the current background colour at pixel location X, Y. | |
- UINT | X1 |
- UINT | Y1 |
- VOID | Return |
ReadFontStat | |
Gets a stat from the selected embedded ASCII font data. | |
- BYTE | Font |
Font selection range: 0 to (NumFonts - 1) | |
- BYTE | Index |
0=SpaceWidth, 1=PixelHeight | |
- BYTE | Return |
ControlContrast | |
Sets the display contrast from 0 to 255. | |
- BYTE | Contrast |
Range 0 - 255, Default 207 | |
- VOID | Return |
Uninitialise | |
- VOID | Return |
ClearDisplay | |
This macro clears the display of any previous output by overwriting the entire display with the background colour. | |
- VOID | Return |
SetBackgroundColour | |
Specifies the colour of the foreground | |
- BYTE | PixelColour |
0=White, 1=Black | |
- VOID | Return |
SetForegroundColour | |
Specifies the colour of the foreground. | |
- BYTE | PixelColour |
0=White, 1=Black | |
- VOID | Return |
Initialise | |
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called. | |
- VOID | Return |
Initialise | |
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called. | |
- VOID | Return |
ARB4 | |
Loads the binary-data to an existing arbitrary waveform memory location ARB4. | |
- BYTE | Waveform |
- VOID | Return |
CLKSRRet | |
Returns the clock source <INT> or <EXT>. | |
[[File:]] - | Return |
MODPMDEV | |
Sets PM waveform deviation to <nrf> degrees. (Lower limit: -360° - Upper limit: 360°). | |
[[File:]] - | Degrees |
Sets PM waveform deviation in degrees (-360 - 360). | |
- VOID | Return |
MSTLOCK | |
Sends signal to SLAVE generator to get synchronised | |
- VOID | Return |
HILVL | |
Sets the amplitude-high-level to <nrf> Volts. (Lower limit: -0.490 V - Upper limit: 5.000 V). | |
[[File:]] - | HighLevel |
Sets the amplitude-high-level in Volts(V) (-0.490 V - 5.000 V). | |
- VOID | Return |
ARB3 | |
Loads the binary-data to an existing arbitrary waveform memory location ARB3. | |
- UINT | Waveform |
- VOID | Return |
CALADJ | |
Adjust the selected calibration value by <nrf> (Lower limit: -100 - Upper limit: 100). | |
[[File:]] - | Calibrate |
Adjust the selected calibration value (-100 - 100). | |
- VOID | Return |
STBRet | |
Returns the value of the Status Byte Register in <nr1> numeric format. | |
- BYTE | Return |
ARB2 | |
Loads the binary-data to an existing arbitrary waveform memory location ARB2. | |
- UINT | Waveform |
- VOID | Return |
EERRet | |
Query and clear execution error number register. | |
- STRING | Return |
MODFMSRC | |
Sets FM waveform source to; 0 INT, 1 = EXT. | |
[[File:]] - | Source |
Sets FM waveform source (0 = INT, 1 = EXT). | |
- VOID | Return |
MODAMFREQ | |
Sets AM waveform frequency to <nrf> Hz. (Lower limit: 1uHz - Upper limit: 20kHz). | |
[[File:]] - | Frequency |
Sets AM waveform frequency in Hertz(Hz) (1uHz - 20kHz). | |
- VOID | Return |
ESE | |
Sets the Standard Event Status Enable Register to the value of <nrf>. | |
- BYTE | Value |
Value of register 0-255 | |
- VOID | Return |
ARB1 | |
Loads the binary-data to an existing arbitrary waveform memory location ARB1. | |
- UINT | Waveform |
16 Bit binary number for arbitrary waveform. | |
- VOID | Return |
ARB4DEFRet | |
Returns user specified waveform name, waveform pint interpolation state and waveform length of ARB4. | |
- STRING | Return |
CLS | |
Clears status byte register of the interface. | |
- VOID | Return |
MSTRELOCK | |
Resynchronises the two generators in MASTER-SLAVE mode. | |
- VOID | Return |
NOISLVL | |
Sets the output noise level to <nr1> %. (Lower limit: 0% - Upper limit: 50%) | |
- BYTE | Percent |
Sets the output noise level in percent. (0 - 50) | |
- VOID | Return |
LOCKMODE | |
Sets the synchronising mode to; 0 = MASTER, 1 = SLAVE, 2 = INDEP. | |
- BYTE | Mode |
Sets the synchronising mode (0 = MASTER, 1 = SLAVE, 2 = INDEP). | |
- VOID | Return |
ADDRESSRet | |
Returns the instruments address | |
[[File:]] - | Return |
MODPMSRC | |
Sets PM waveform source to; 0 INT, 1 = EXT. | |
[[File:]] - | Source |
Sets PM waveform source (0 = INT, 1 = EXT). | |
- VOID | Return |
MODPWMSRC | |
Sets PWM waveform source to; 0 = INT, 1 = EXT. | |
[[File:]] - | Source |
Sets PWM waveform source (0 = INT, 1 = EXT). | |
- VOID | Return |
MOD | |
Sets modulation to; 0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM. | |
- BYTE | Modulation |
Sets modulation (0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM). | |
- VOID | Return |
ISTRet | |
Returns IST local message as defined by IEEE Std. 488.2. The syntax of the response is 0<rmt>, if the local message is false, or 1<rmt>, if the local message is true. | |
[[File:]] - | Return |
LRNRet | |
Returns the complete setup of the instrument as a binary data block | |
[[File:]] - | Return |
OPCRet | |
Query Operation Complete status. The response is always 1<rmt> and will be available immediately the command is executed because all commands are sequential. | |
[[File:]] - | Return |
PULSRANGE | |
Sets PWM waveform source to <1>, <2> or <3>; 1 = 1, 2 = 2, 3 = 3. | |
- BYTE | Range |
Sets the pulse rise and fall range. (1, 2 or 3) | |
- VOID | Return |
TSTRet | |
The generator has no self test capability and the response is always 0 <rmt>. | |
[[File:]] - | Return |
BSTTRGPOL | |
Sets the burst trigger slope to; 0 = POS, 1 = NEG. | |
[[File:]] - | Slope |
Set the burst trigger slope (0 = POS, 1 = NEG). | |
- VOID | Return |
ARB3Ret | |
Returns the binary-data from an existing abbitrary wavefrom memory location. | |
- UINT | Return |
BSTPHASE | |
Sets the burst phase to <nrf> degrees. (Lower limit: -360 - Upper limit: 360) | |
[[File:]] - | Degrees |
Sets the burst phase in degrees (-360 - 360) | |
- VOID | Return |
SWPTRGPER | |
Sets the sweep trigger period to <nrf> seconds | |
[[File:]] - | Seconds |
Set the sweep trigger period in seconds. | |
- VOID | Return |
PULSDLY | |
Sets the waveform delay to <nrf> sec | |
[[File:]] - | Sec |
- VOID | Return |
Initialise | |
Opens the COM port ready for communications. | |
- VOID | Return |