/
fonctions 4dsystem SPE.csv
We can make this file beautiful and searchable if this error is corrected: Illegal quoting in line 45.
170 lines (170 loc) · 60.3 KB
/
fonctions 4dsystem SPE.csv
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
#nom;cmd goldelox;cmd picaso;cmd diablo16;cmd pixxi;arguments en entrée;Valeurs de retour;commentaires paramètres en entrée;commentaires paramètres en sortie;commentaires fonctionnement
#;si vide : pas implémenté pour le type d’écran;;;;uint16_t par défaut, sinon le type est spécifié entre (). vide si pas D’arguments;si précédé d’un ‘ :’ → signifie que la valeur est retournée sur diablo16 et picaso, mais pas sur goldelox;;;
txt_moveCursor;0xFFE4;0xFFE9 ;0xFFF0;0xFFE9 ;line, column;ack;line : Holds a positive value for the required line position. column :Holds a positive value for the required column position.;;Moves the text cursor to a screen position set by line and column parameters. The line and column position is calculated, based on the size and scaling factor for the currently selected font. When text is outputted to screen it will be displayed from this position. The text position could also be set with “Move Origin” command if required to set the text position to an exact pixel location. Note that lines and columns start from 0, so line 0, column 0 is the top left corner of the display.
txt_putCh;0xFFFE;0xFFFE;0xFFFE;0xFFFE;car;ack;car : Holds a positive value for the required character.;;Prints a single character to the display
txt_putStr;0x0006;0x0018 ;0x0018;0x0018 ;(const char *) cstr;ack,:length;cstr : Holds a Null terminated string. NOTE: Maximum characters in the string is 255 for GOLDELOX or 511 for PICASO and DIABLO16;length : Length of the string printed;Prints a string to the display and returns the pointer to the string.
txt_charWidth;0x0002;0x001E;0x001E;0x001E;(char) car;ack,width;car : The ASCII character for the width calculation.;width : Width of a single character in pixel units.;Calculate the width in pixel units for a character, based on the currently selected font. The font can be proportional or mono-spaced. If the total width of the character exceeds 255 pixel units, the function will return the 'wrapped' (modulo 256) value.
txt_charHeight;0x0001;0x001D ;0x001D;0x001D ;(char) car;ack,height;car : The ASCII character for the height calculation.;height : Height of a single character in pixel units.;Calculate the height in pixel units for a character, based on the currently selected font. The font can be proportional or mono-spaced. If the total height of the character exceeds 255 pixel units, the function will return the 'wrapped' (modulo 256) value.
txt_fgColour;0xFF7F;0xFFE7;0xFFEE;0xFFE7;colour;ack,:oldCol;Colour : colour to be set.;oldCol : Previous Text Foreground Colour.;Sets the text foreground colour.
txt_bgColour;0xFF7E;0xFFE6;0xFFED;0xFFE6;colour;ack,:oldCol;Colour : colour to be set.;oldCol : Previous Text Background Colour.;Sets the text background colour.
txt_fontID;0xFF7D;0xFFE5;0xFFEC;0xFFE5;id;ack,:oldFont;Id : 0 for System font (Default Fonts), 7 for Media fonts;oldFont : Previous Font ID.;Sets the required font using its ID.
txt_widthMult;0xFF7C;0xFFE4;0xFFEB;0xFFE4;wMultiplier;ack,:oldMul;wMultiplier : Width multiplier, 1 to 16 (Default =1);oldMul : Previous Multiplier value.;Sets the text width multiplier between 1 and 16.
txt_heightMult;0xFF7B;0xFFE3;0xFFEA;0xFFE3;hMultiplier;ack,:oldMul;hMultiplier : Height multiplier, 1 to 16 (Default =1);oldMul : Previous Multiplier value.;Sets the text height multiplier between 1 and 16.
txt_xgap;0xFF7A;0xFFE2;0xFFE9;0xFFE2;xGap;ack,:oldGap;xGap : pixelcount 0 to 32(Default =0);oldGap : Previous pixelcount value.;Sets the pixel gap between characters (x-axis), where the gap is in pixel units.
txt_ygap;0xFF79;0xFFE1;0xFFE8;0xFFE1;yGap;ack,:oldGap;yGap : pixelcount 0 to 32(Default =0);oldGap : Previous pixelcount value.;Sets the pixel gap between characters (y-axis), where the gap is in pixel units.
txt_bold;0xFF76;0xFFDE;0xFFE5;0xFFDE;mode;ack,:oldBold;mode : 1 for ON, 0 for OFF.;oldBold : Previous Bold status.;Sets the Bold attribute for the text.
txt_inverse;0xFF74;0xFFDC;0xFFE3;0xFFDC;mode;ack,:oldInv;mode : 1 for ON, 0 for OFF.;oldInv : Previous ‘Text Inverse’ status.;Sets the text to be inverse.
txt_italic;0xFF75;0xFFDD;0xFFE4;0xFFDD;mode;ack,:oldItal;mode : 1 for ON, 0 for OFF.;oldItal : Previous Italic Text status.;Sets the text to italic.
txt_opacity;0xFF77;0xFFDF;0xFFE6;0xFFDF;mode;ack,:oldOpa;mode : 1 for ON. (Opaque), 0 for OFF. (Transparent);oldOpa : Previous Text Opacity status.;Selects whether or not the 'background' pixels are drawn (Default mode is OPAQUE with BLACK background).
txt_underline;0xFF73;0xFFDB;0xFFE2;0xFFDB;mode;ack,:oldUnder;mode : 1 for ON, 0 for OFF.;oldUnder : Previous Text Underline status.;Sets the text to underlined.vThe ‘Text Underline’ attribute is cleared internally once the text (character or string) is displayed. Note: The “Text Y-gap” command is required to be at least 2 for the underline to be visible.
txt_attributes;0xFF72;0xFFDA;0xFFE1;0xFFDA;bitfield;ack,:oldAttr;bitfield : bold=1<<4, italic=1<<5, inverse=1<<6, underlined=1<<7 (bits 0-3 and 8-15 are reserved);oldAttr : Previous Text Attributes status.;Controls the following functions grouped : Text Bold, Text Italic, Text Inverse, Text Underlined. The Attributes are set to normal internally once the text (character or string) is displayed.
txt_set;0xFFE3;;;;function, value;ack;function : 7 = Sets the Delay between the characters being printed through Put Character or Put String functions, value = 0(Default) to 255 (ms);;Sets various parameters for the Text commands.
txt_wrap;;0xFFD9;0xFFE0;0xFFD9;xpos;ack,oldWrap;xpos : 0 for OFF (Default), 1 to N for Wrap position in Pixels.;oldWrap : Previous wrap position;Sets the pixel position where text wrap will occur at RHS. The feature automatically resets when screen mode is changed.
gfx_cls;0xFFD7;0xFFCD;0xFF82;0xFFCD;;ack;;;Clears the screen using the current background colour. Brings some of the settings back to default such as Outline colour set to BLACK, Pen set to OUTLINE, Text magnifications set to 1, All origins set to 0:0.
gfx_changeColour;0xFFBE;0xFFB4;0xFF69;0xFFB4;oldColour, newColour;ack;oldColor : sample colour to be changed within the clipping window, newColor : new colour to change all occurrences of old colour within the clipping window;;Changes all oldColour pixels to newColour within the clipping window area.
gfx_circle;0xFFCD;0xFFC3;0xFF78;0xFFC3;x, y, radius, colour;ack;x, y : centre of the circle, radius : radius of the circle, colour : colour of the circle.;;Draws a circle with centre point and radius using the specified colour.
gfx_circleFilled;0xFFCC;0xFFC2;0xFF77 ;0xFFC2;x, y, radius, colour;ack;x, y : centre of the circle, radius : radius of the circle, colour : colour of the circle.;;Draws a solid circle with centre point and radius using the specified colour. Outline colour can be specified with the “Outline Colour” command, if set to 0, no outline is drawn.
gfx_line;0xFFD2;0xFFC8;0xFF7D;0xFFC8;x1,y1,x2,y2,colour;ack;x1,y1 : starting coordinates of the line, x2,y2 : ending coordinates of the line, colour : colour of the line.;;Draws a line from x1,y1 to x2,y2 using the specified colour. The line is drawn using the current object colour. The current origin is not altered. The line may be tessellated with the “Line Pattern” command.
gfx_rectangle;0xFFCF;0xFFC5;0xFF7A;0xFFC5;tlx,tly,brx,bry,colour;ack;tlx,tly : top left corner of the rectangle, brx,bry : bottom right corner of the rectangle, colour : colour of the rectangle.;;Draws a rectangle from x1, y1 to x2, y2 using the specified colour. The line may be tessellated with the “Line Pattern” command.
gfx_rectangleFilled;0xFFCE;0xFFC4 ;0xFF79;0xFFC4 ;tlx,tly,brx,bry,colour;ack;tlx,tly : top left corner of the rectangle, brx,bry : bottom right corner of the rectangle, colour : colour of the rectangle.;;Draws a Filled rectangle from x1, y1 to x2, y2 using the specified colour. The line may be tessellated with the “Line Pattern” command. Outline colour can be specified with the “Outline Colour” command, if set to 0, no outline is drawn.
gfx_polyline;0x0005;0x0015;0x0015;0x0015;n,vx[n],vy[n],colour;ack;n : number of elements in the x and y arrays specifying the vertices for the polyline, vx[n] : array of elements for the x coordinates of the vertices, vy[n] : array of elements for the y coordinates of the vertices, colour : colour of the polyline.;;Plots lines between points specified by a pair of arrays using the specified colour. The lines may be tessellated with the “Line Pattern” command
gfx_polygon;0x0004;0x0013;0x0013;0x0013;n,vx[n],vy[n],colour;ack;n : number of elements in the x and y arrays specifying the vertices for the polygon, vx[n] : array of elements for the x coordinates of the vertices, vy[n] : array of elements for the y coordinates of the vertices, colour : colour of the polygon.;;Plots lines between points specified by a pair of arrays using the specified colour. The last point is drawn back to the first point, completing the polygon. The lines may be tessellated with “Line Pattern” command.
gfx_polygonFilled;;0x0014 ;0x0014;0x0014 ;n,vx[n],vy[n],colour;ack;n : number of elements in the x and y arrays specifying the vertices for the polygon, vx[n] : array of elements for the x coordinates of the vertices, vy[n] : array of elements for the y coordinates of the vertices, colour : colour of the polygon.;;Draws a solid Polygon between specified vertices using the specified colour. The last point is drawn back to the first point, completing the polygon. Vertices must be a minimum of 3 and can be specified in any fashion.
gfx_triangle;0xFFC9;0xFFBF;0xFF74 ;0xFFBF;x1,y1,x2,y2,x3,y3,colour;ack;x1,y1 : first vertice of the triangle, x2,y2 : second vertice of the triangle, x3,y3 : third vertice of the triangle, colour : colour of the triangle.;;Draws a triangle outline between specified vertices using the specified colour. The line may be tessellated with the “Line Pattern” command.
gfx_triangleFilled;;0xFFA9 ;0xFF59;0xFFA9 ;x1,y1,x2,y2,x3,y3,colour;ack;x1,y1 : first vertice of the triangle, x2,y2 : second vertice of the triangle, x3,y3 : third vertice of the triangle, colour : colour of the triangle.;;Draws a solid triangle between specified vertices using the specified colour.
gfx_orbit;0x0003;0x0012;0x0012;0x0012;angle,distance;ack,Xdist,Ydist;angle : angle from the origin to the remote point. The angle is specified in degrees, distance : distance from the origin to the remote point in pixel units.;Xdist,Ydist : coordinates from the current origin.;Calculates the coordinates of a distant point relative to the current origin, where the only known parameters are the angle and the distance from the current origin.
gfx_putPixel;0xFFCB;0xFFC1;0xFF76;0xFFC1;x, y,colour;ack;x, y : pixel coordinates, colour : colour of the pixel;;Draws a pixel at specified coordinates using the specified colour.
gfx_getPixel;0xFFCA;0xFFC0;0xFF75;0xFFC0;x,y;ack,colour;x, y : pixel coordinates;colour : 16bit colour of the pixel.;Reads the colour value of the pixel at the specified coordinate.
gfx_moveTo;0xFFD6;0xFFCC;0xFF81;0xFFCC;x,y;ack;x,y : coordinates of the new origin.;;Moves the origin to a new position.
gfx_lineTo;0xFFD4 ;0xFFCA;0xFF7F;0xFFCA;x,y;ack;x,y : line end coordinates.;;Draws a line from the current origin to a new position. The Origin is then set to the new position. The line is drawn using the current object colour, using the “Set Graphics Parameters” – “Object Colour” command. The line may be tessellated with the “Line Pattern” command.
gfx_clipping;0xFF6C;0xFFA2 ;0xFF46;0xFFA2 ;mode;ack;mode : 0 = Clipping Disabled, 1 = Clipping Enabled;;Enables or Disables the ability for Clipping to be used.
gfx_clipWindow;0xFFBF;0xFFB5;0xFF6A;0xFFB5;tlx,tly,brx,bry;ack;tlx,tly : top left corner of the clipping window, brx,bry : bottom right corner of the clipping window.;;Specifies a clipping window region on the screen such that any objects and text placed onto the screen will be clipped and displayed only within that region. For the clipping window to take effect, the clipping setting must be enabled separately using the “Clipping” command
gfx_setClipRegion;0xFFBC;0xFFB3;0xFF68;0xFFB3;;ack;;;Forces the clip region to the extent of the last text that was printed, or the last image that was shown.
gfx_ellipse;;0xFFB2;0xFF67;0xFFB2;x,y,xrad,yrad,colour;ack;x,y : center of ellipse, xrad : x-radius of ellipse, yrad : y-radius of ellipse, colour : colour of the ellipse.;;Plots a coloured Ellipse on the screen at centre x, y with x-radius = xrad and y-radius = yrad.
gfx_ellipseFilled;;0xFFB1;0xFF66;0xFFB1;x,y,xrad,yrad,colour;ack;x,y : center of ellipse, xrad : x-radius of ellipse, yrad : y-radius of ellipse, colour : colour of the ellipse.;;Plots a solid coloured Ellipse on the screen at centre x, y with x-radius = xrad and y-radius = yrad.
gfx_button;;0x0011;0x0011;0x0011;state,x,y,buttoncolour,txtcolour,font,txtWidth,txtHeight,(const char *) cstr;ack;"state : appearance of button, 0 = depressed; 1 = raised, x,y : top left corner position, buttoncolour : button colour, txtcolour : text colour, font : font ID, txtWidth : text width (font width multiplier, minimum must be 1) , txtHeight : teext height (font width multiplier, minimum must be 1), cstr : text string, printable ASCII character set Null terminated. May have \n characters to create a multiline button.";; Draws a 3 dimensional Text Button at location defined by parameters. Size depends on font, width, height and length of text. Can contain multiple lines of text by having \n character in the string. In this case, the widest text in the string sets the overall width, and height is set by the number of text lines. In case of multiple lines, each line is left justified. To centre or right justify text, prepare string according to requirements.
gfx_panel;;0xFFAF;0xFF5F;0xFFAF;state,x,y,width,height,colour;ack;"state : appearance of panel, 0 = recessed; 1 = raised, x,y : top left corner position of the panel, width : width of the panel ,height : height of the panel, colour : colour of the panel.";;Draws a 3 dimensional rectangular panel
gfx_slider;;0xFFAE;0xFF5E;0xFFAE;mode,tlx,tly,brx,bry,colour,scale,(int16_t)value;ack;mode : 0 = Indented, 1 = Raised, 2 = Hidden (background colour), tlx,tly : top left corner position, brx,bry : bottom right corner position ,colour : colour of the slider, scale : full scale range of the slider for the thumb (0 to n), value : relative position of the thumb on the slider bar;;Draws a vertical or horizontal slider bar. Mode operation rules : if width > height slider is assumed to be horizontal, if height <= width slider is assumed to be vertical, If value parameter is positive, thumb is set to the position that is the proportion of value to the scale parameter. If value parameter is negative, thumb is driven to the graphics position set by the ABSolute of value. Thumb colour is determine by the “Set Graphics Parameters” – “Object Colour” command, however, if the current object colour is BLACK, a darkened shade of the colour parameter is used for the thumb .
gfx_screenCopyPaste;;0xFFAD;0xFF5D;0xFFAD;xs, ys, xd, yd, width,height;ack;xs, ys : position of the top left corner of the area to be copied (source), xd, yd : position of the top left corner of where the paste is to be made (destination), width : width of the copied area, height : height of the copied area.;;Copies an area of the screen from xs, ys of size given by width and height parameters and pastes it to another location determined by xd, yd.
gfx_bevelShadow;;0xFF98;0xFF3C;0xFF98;value;ack,oldBevel;value : number of pixel, 0 = No Bevel Shadow, 1-4 = Number of Pixels Deep (default = 3);oldBevel : previous bevel shadow status.;Changes the graphics “Draw Button” commands bevel shadow depth
gfx_bevelWidth;;0xFF99;0xFF3D;0xFF99;value;ack,oldWidth;value : 0 = No Bevel, 1-15 = Number of Pixels Wide (Default = 2);oldWidth : previous bevel width status.;Changes the graphics “Draw Button” commands bevel width
gfx_bgCcolour;0xFF6E;0xFFA4;0xFF48;0xFFA4;colour;ack,:oldCol;colour : colour to be set (0-65535 or HEX 0x0000-0xFFFF);oldCol : previous background Colour.;Sets the screen background colour
gfx_outlineColour;0xFF67;0xFF9D;0xFF41;0xFF9D;colour;ack,:oldCol;colour : colour to be set (0-65535 or HEX 0x0000-0xFFFF), set to 0 for no effect;oldCol : previous outline Colour.;Sets the outline colour for rectangles and circles.
gfx_contrast;0xFF66;0xFF9C;0xFF40 ;0xFF9C;contrast;ack,:oldContrast;contrast : 0 = Display OFF, 1 - 15 = Contrast Level;oldContrast : previous Contrast value.;Sets the contrast of the display, or turns it On/Off depending on display model
gfx_frameDelay;0xFF69;0xFF9F;0xFF43;0xFF9F;delayMsec;ack,:oldDelay;delayMsec : delay in milliseconds (0-255);oldDelay : previous Frame Delay value.;Sets the inter frame delay for the “Media Video” command
gfx_linePattern;0xFF65;0xFF9B;0xFF3F;0xFF9B;pattern;ack,:oldPattern;pattern : 0 = all line pixels are on (Default), 0-65535 (or HEX 0x0000-0xFFFF) = number of bits in the line are turned off to form a pattern;oldPattern : previous Line Pattern value.;Sets the line draw pattern for line drawing. If set to zero, lines are solid, else each '1' bit represents a pixel that is turned off.
gfx_screenMode;0xFF68;0xFF9E;0xFF42;0xFF9E;mode;ack,:oldMode;mode : 0 = Landscape, 1 = Landscape reverse, 2 = Portrait, 3 = Portrait reverse;oldMode : previous Screen Mode value.;Alters the graphics orientation (Landscape, Landscape reverse, Portrait or Portrait reverse)
gfx_transparency;;0xFFA0;0xFF44;0xFFA0;mode;ack,oldMode;mode : 0 = Transparency OFF, 1 = Transparency ON;oldMode : previous Transparency value.;Turns the transparency ON or OFF. Transparency is automatically turned OFF after the next image or video command.
gfx_transparentColour;;0xFFA1;0xFF45;0xFFA1;colour;ack,oldColor;colour : colour to make transparent (0-65535 or HEX 0x0000-0xFFFF);oldColor : previous Transparent Colour value.;Alters the colour that needs to be made transparent.
gfx_set;0xFFD8;0xFFCE;0xFF83;0xFFCE;function, value;ack;function, value : see « Serial Commands Reference Manual » of appropriate display processor;;Sets various parameters for the graphics gommands.
gfx_get;;0xFFA6;0xFF4A;0xFFA6;mode;ack,value;mode : 0 = Current orientations maximum X value (X_MAX), 1 = Current orientations maximum Y value (Y_MAX), 2 = Left location of last Object, 3 = Top location of Object, 4 = Right location of last Object, 5 = Bottom location of Object;value : Mode=0: horizontal resolution - 1, Mode=1: vertical resolution - 1, Mode=2: left location of the last drawn object, Mode=3: top location of the last drawn object, Mode=4: right location of the last drawn object, Mode=5: bottom location of the last drawn object.;Returns various graphics parameters to the caller.
gfx_scale;;;;0xFEAA;handle, param;ack;handle: A pointer to the memory block for widget variable utilization, params: A pointer to the memory block holding the widget parameters;;The Draw Scale command draws the Scale PmmC widget on the screen.
gfx_pannel2;;;;0xFEC7;options, x, y, width, height, width1, width2, maincolour, shadowcolour, fcolour;ack;options: Bevel direction (0 – Inwards, 1 – Outwards) Additional bit for filling panel with fill color (0x8000 - PANEL2_FILLED), x & y: Specifies the Top-Left X-position, Top-Left Y-position, width: Specifies the panel width, height: Specifies the panel height, width1: Outer bevel offset, width2: Inner bevel offset, maincolour: Main bevel colour, shadowcolour: Shadow bevel colour, fcolour: Fill colour ;; The Draw Panel 2 command draws the Panel 2 PmmC widget on the screen.
gfx_button4;;;;0xFEAC;value, handle, params;ack;value: A value (usually a constant) specifying the current frame of the widget, handle: A pointer to the memory block for widget variable utilization, params: A pointer to the memory block holding the widget parameters;;The Draw Button4 command draws the Button4 PmmC widget on the screen.
gfx_switch;;;;0xFEAD ;value, handle, params;ack;value: A value (usually a constant) specifying the current frame of the widget, handle: A pointer to the memory block for widget variable utilization, params: A pointer to the memory block holding the widget parameters;;The Draw Switch command draws the Switch PmmC widget on the screen.
gfx_slider5;;;;0xFEAF;value, handle, params;ack;value: A value (usually a constant) specifying the current frame of the widget, handle: A pointer to the memory block for widget variable utilization, params: A pointer to the memory block holding the widget parameters;;The Draw Slider5 command draws the Slider5 PmmC widget on the screen.
gfx_dial;;;;0xFEC5 ;value, handle, params;ack;value: A value (usually a constant) specifying the current frame of the widget, handle: A pointer to the memory block for widget variable utilization, params: A pointer to the memory block holding the widget parameters;;The Draw Dial command draws the Dial PmmC widget on the screen.
gfx_led;;;;0xFEAB;value, handle, params;ack;value: A value (usually a constant) specifying the current frame of the widget, handle: A pointer to the memory block for widget variable utilization, params: A pointer to the memory block holding the widget parameters;;The Draw Led command draws the Led PmmC widget on the screen.
gfx_gauge;;;;0xFEC4;value, handle, params;ack;value: A value (usually a constant) specifying the current frame of the widget, handle: A pointer to the memory block for widget variable utilization, params: A pointer to the memory block holding the widget parameters;;The Draw Gauge command draws the Gauge PmmC widget on the screen.
gfx_angularMeter;;;;0xFEC8;value, handle, params;ack;value: A value (usually a constant) specifying the current frame of the widget, handle: A pointer to the memory block for widget variable utilization, params: A pointer to the memory block holding the widget parameters;;The Draw Angular Meter command draws the Angular Meter PmmC widget on the screen.
gfx_ledGigit;;;;0xFEC1;x, y, digitSize, onColour, offColour, value;ack;x & y: Specifies the top left corner position of the digit on the screen, digitSize: Specifies the size of the digit, onColour: Specifies the colour of the activate LED segments, offColour: Specifies the colour of the inactive LED segments, value: Value to be displayed by the widget;;The Draw Led Digit command draws the Led Digit PmmC widget on the screen.
gfx_ledDigits;;;;0xFEC2;value, handle, params;ack;value: A value (usually a constant) specifying the current frame of the widget, handle: A pointer to the memory block for widget variable utilization, params: A pointer to the memory block holding the widget parameters;;The Draw Led Digits command draws the Led Digits PmmC widget on the screen.
media_init;0xFFB1;0xFF89 ;0xFF25;0xFF89 ;;ack,value;;value : Non-Zero = card is present and successfully initialised, 0 = no card is present or not able to initialise.;Initialises a uSD/SD/SDHC memory card for further operations. SD card is connected to the SPI of the processor display.
media_setAdd;0xFFB9;0xFF93 ;0xFF2F;0xFF93 ;hiAddr, loAddr;ack;hiAddr : high word (upper 2 bytes) of a 4 byte media memory byte address location, loAddr : low word (lower 2 bytes) of a 4 byte media memory byte address location.;;Sets the media memory internal Address pointer for access at a non-sector aligned byte address.
media_setSector;0xFFB8;0xFF92;0xFF2E;0xFF92;hiAddr, loAddr;ack;hiAddr : high word (upper 2 bytes) of a 4 byte media memory byte address location, loAddr : low word (lower 2 bytes) of a 4 byte media memory byte address location.;;Sets the media memory internal Address pointer for sector access.
#media_readSector;;0x0016;0x0016;0x0016;;ack,status,(uint8_t)sector[512];;status : 1 = successful media response, 0 = attempt failed, sector : 512 bytes (256 words);Reads and returns 512 bytes (256 words) pointed to by the internal Sector pointer, determined by the “Set Sector Address” command. After the read the Sector pointer is automatically incremented by 1.
#media_writeSector;;0x0017;0x0017;0x0017;(uint8_t)sector[512];ack,status;sector : 512 bytes (256 words) to be written to the media sector address.;status : 1 = successful media response, 0 = attempt failed;Writes 512 bytes (256 words) from a source memory block into the uSD card. After the write the Sect pointer is automatically incremented by 1.
media_readByte;0xFFB7;0xFF8F;0xFF2B ;0xFF8F;;ack,value;;value : byte value in the LSB.;Returns the byte value from the current media address, set by the “Set Byte Address” command. The internal byte address will then be internally incremented by one.
media_readWord;0xFFB6;0xFF8E ;0xFF2A;0xFF8E ;;ack,value;;value : word value;Returns the word value (2 bytes) from the current media address, set by the “Set Byte Address” command. The internal byte address will then be internally incremented by two. If the address is not aligned, the word will still be read correctly.
media_writeByte;0xFFB5;0xFF8D;0xFF29;0xFF8D;s;ack,status;s : byte value, in the LSB, to be written at the current byte address location.;status : Non Zero = successful media response, 0 = attempt failed.;Writes a byte to the current media address that was initially set with the “Set Sector Address” command. See « Serial Commands Reference Manual » for more information.
media_writeWord;0xFFB4;0xFF8C;0xFF28;0xFF8C;value;ack,status;value : 16 bit word to be written at the current media address location.;status : Non Zero = successful media response, 0 = attempt failed.;Writes a word to the current media address that was initially set with the “Set Sector Address” command. See « Serial Commands Reference Manual » for more information.
media_flush;0xFFB2;0xFF8A;0xFF26 ;0xFF8A;;ack,status;;status : Non Zero = successful media response, 0 = attempt failed.;After writing any data to a sector, the Flush Media command should be called to ensure that the current sector that is being written is correctly stored back to the media else write operations may be unpredictable.
media_image;0xFFB3;0xFF8B;0xFF27;0xFF8B;x,y;ack;x,y : top left position where the image will be displayed.;;Displays an image from the media storage at the specified co-ordinates. The image address is previously specified with the “Set Byte Address” command or “Set Sector Address” command. If the image is shown partially off screen, it may not be displayed correctly.
media_video;0xFFBB;0xFF95;0xFF31;0xFF95;x,y;ack;x,y : top left position where the video clip will be displayed.;;Displays a video clip from the media storage device at the specified co-ordinates. The video address location in the media is previously specified with the “Set Byte Address” or “Set Sector Address” commands. If the video is shown partially off screen, it may not be displayed correctly. Note that showing a video blocks all other processes until the video has finished showing. See the “Display Video Frame” command for alternatives.
media_videoFrame;0xFFBA;0xFF94;0xFF30;0xFF94;x,y,(int16_t)frameNumber;ack;x,y : top left position of the video frame to be displayed, frameNumber : required frame number to be displayed.;;Displays a video from the media storage device at the specified co-ordinates. The video address is previously specified with the “Set Byte Address” command or “Set Sector Address” command. If the video is shown partially off it may not be displayed correctly. The frames can be shown in any order. This function gives a great flexibility for showing various icons from an image strip, as well as showing videos while doing other tasks.
misc_peekB ;0xFFF6;;;;eveReg;ack,value;eveReg : byte register address;value : register value in the LSB.;Returns the EVE System Byte Register value in the lower byte. See EVE System Registers Memory Map in « Serial Commands Reference Manual ».
misc_pokeB ;0xFFF4;;;;eveReg, value;ack;eveReg : byte register address, value : register value in the LSB.;;Sets the EVE System Byte Register value in the lower byte. See EVE System Registers Memory Map in « Serial Commands Reference Manual ».
misc_peekW ;0xFFF5;;;;eveReg;ack,value;eveReg : word register address;value : registre value;Returns the EVE System Word Register value. See EVE System Registers Memory Map in « Serial Commands Reference Manual ».
misc_pokeW;0xFFF3;;;;eveReg,value;ack;eveReg : word register address, value : register value;;Sets the EVE System Word Register value. See EVE System Registers Memory Map in « Serial Commands Reference Manual ».
misc_peekM ;;0x0027;0x0027;0x0027;address;ack,value;address : address to be peeked;value : contents of the specified memory address.;Returns the word contents of a specified memory address. This command would normally be used to read the contents of File and/or ImageControl handles.
misc_pokeM;;0x0028;0x0028;0x0028;address,value;ack;address : address to be poked, value : data to be poked into the address;;Sets the word contents of a specified memory address. This command would normally be used to alter the contents of File and/or ImageControl handles.
misc_joystick;0xFFD9;;;;;ack,value;;value : value of the Joystick position, 0=Released, 1=Up , 2=Left , 3=Down , 4=Right, 5=Press (5 position switch implementation).;Return the value of the joystick position. Refer to the processor datasheet.
misc_beep;0xFFDA;;;;note, duration_ms;ack;note : frequency of the note (0-64), duration_ms : time in milliseconds that the note will be played for.;;Produce a single musical note for the required duration through IO2.
misc_setbaudWait;0x000B;0x0026;0x0026;0x0026;(int16_t) index;;index : baud rate index value. See index table in « Serial Commands Reference Manual » ;;Set the required baud rate. Please refer to the « Serial Commands Reference Manual ».
sys_sleep;;0xFF3B ;0xFE6D;0xFF3B ;duration_s;ack,duration;duration_s : Sleep duration (0-65535) approximately in seconds (in sleep mode, timing is controlled by an RC oscillator, so is not totally accurate);ack,duration : remaining time when touch screen is touched, else returns zero.;"Puts display and processor into low power mode for a period of time. If ""duration"" is zero, goes into sleep mode forever and needs power cycling to re-initialize. If ""duration"" is 1 to 65535, display will sleep for that period of time, or will be woken when touch screen is touched. Returns remaining time when screen was touched. When returning from sleep mode, display and processor are restored from low power mode."
sys_memFree;;0xFF24;0xFE5F;0xFF24;handle;ack,status;handle : pointer to the memory block.;status : Non Zero = operation successful, 0 = attempt failed. ;"Releases the memory space used by the the ""Load Image Control"" and ""File Load Function"" commands."
sys_memHeap;;0xFF23;0xFE5E;0xFF23;;ack,avail;;avail : largest available memory chunk of the heap.;Returns byte size of the largest chunk of memory available in the heap.
sys_getModel;0x0007;0x001A;0x001A;0x001A;;ack,n,(char)str[n];;n : number of characters in the model name to return, str[n] : display module’s model name (without NULL terminator).;Returns the Display Model in the form of a string without Null terminator.
sys_getVersion;0x0008;0x001B;0x001B;0x001B;;ack,version;;version : SPE Version installed on the module.;Returns the SPE Version installed on the module.
sys_getPmmC;0x0009;0x001C;0x001C;0x001C;;ack,version;;version : PmmC Version installed on the module.;Returns the PmmC Version installed on the module.
misc_screenSaverTimeout;0x000C;;;;timout_ms;ack;timout_ms : Screen saver timeout in milliseconds (1 to 65535, 0 disables the screen saver).;;Set the screen saver Timeout. Default screen saver timeout settings could be adjusted. This feature is display dependent, please refer to module's datasheet.
misc_screenSaverSpeed;0x000D;;;;speed;ack;speed : screen saver speed. Range is display dependant. Please refer to module datasheet;;Set the screen saver speed. Default screen saver speed settings could be adjusted. This feature is display dependent, please refer to module datasheet.
misc_screenSaverMode;0x000E ;;;;mode;ack;mode : screen saver scroll direction. Display dependant, please refer to module datasheet.;;Set the screen saver scroll direction. This feature is display dependent, please refer to module's datasheet.
touch_detectRegion;;0xFF39;0xFE6A;0xFF39;tlx,tly,brx,bry;ack;tlx,tly : position of the top left corner of the region, brx,bry : position of the bottom right corner of the region.;;Specifies a touch detect region on the screen. This setting will filter out any touch activity outside the region and only touch activity within that region will be reported by the status poll “Touch Get” command
touch_set;;0xFF38;0xFE69;0xFF38;mode;ack;mode : 0=Enables and initialises Touch Screen hardware, 1=Disables the Touch Screen (Touch Screen task runs in the background, disabling it when not in use free up extra CPU cycles), 2 = reset the current active region to default (= full screen area);;Sets various Touch Screen related parameters.
touch_get;;0xFF37;0xFE68;0xFF37;mode;ack,value;mode : 0 = get Status, 1 = get X coordinates, 2 = get Y coordinates.;value : mode0 = returns the various states of the touch screen (0=invalid/notouch, 1=press, 2=release, 3=moving), mode1 = returns the X coordinates of the touch reported by mode0, mode2 = returns the Y coordinates of the touch reported by mode0.;Returns various touch screen parameters, based on the touch detect region set by the “Touch Detect Region” command.
file_error;;0xFF1F;0xFE58;0xFF1F;;ack,errno;;errno : error number (0 = no error). ;Returns the most recent error code. See error table in « Serial Commands Reference Manual »
file_count;;0x0001;0x0001;0x0001;(const char *) filename;ack,count;filename : Name of the file(s) for search (passed as a string). Filename must be 8.3 format.;count : number of files that match the criteria.;Returns number of files found that match the criteria. The wild card character '*' matches up with any combination of allowable characters and '?' matches up with any single allowable character.
file_dir;;0x0002;0x0002;0x0002;(const char *) filename;ack,count;filename : Name of the file(s) for search (passed as a string). Filename must be 8.3 format.;count : number of files that match the criteria.;Lists the stream of file names that agree with the search key on the Display Screen. The wild card character ‘*’ matches up with any combination of allowable characters and ‘?’ matches up with any single allowable character. Note: “Find First File and Report” and “Find Next File and Report” are recommended alternatives
file_findFirst;;0x0006;0x0006;0x0006;(const char *) filename;ack,status;filename : Name of the file(s) for search (passed as a string). Filename must be 8.3 format.;status : 1 = at least one file exists that satisfies the criteria, 0 = no file satisfies the criteria.;Returns 1 if at least one file exists that satisfies the file argument. Wildcards are usually used so if the “Find First File” command returns true, further tests can be made using the “Find Next File” command to find all the files that match the wildcard class. Notes : filename is printed on the screen. “Find First File and Report” and “Find Next File and Report” are recommended alternatives in order to return the responses.
file_findFirstRet;;0x0024;0x0024;0x0024;(const char *) filename;ack,length,(char)str[n];filename : Name of the file(s) for search (passed as a string). Filename must be 8.3 format.;length : Length of the filename string, str[n] : Filename if it exists. Filename string is not NULL terminated.;Returns length of filename and filename if at least 1 file exists that matches the criteria. Wildcards are usually used so further tests can be made using “Find Next File” or “Find Next File and Report” commands to find all the files that match the wildcard class.
file_findNext;;0xFF1B;0xFE54;0xFF1B;;ack,status;;status : 1 = at least one file exists that satisfies the criteria, 0 = no file satisfies the criteria.;Returns 1 if more file exists that satisfies the file argument that was given for the “Find First File” or “Find First File and Report” commands. Wildcards must be used for the “Find First File” or “Find First File and Report” commands else this function will always return zero as the only occurrence will have already been found. Note : filename is printed on the screen.
file_findNextRet;;0x0025;0x0025;0x0025;;ack,length,(char)str[n];;length : Length of the filename string, str[n] : Filename if it exists. Filename string is not NULL terminated.;"Returns length of filename and filename if at least 1 file exists that matches criteria given for the “Find First File” or “Find First File and Report” commands. Wildcards must be used for “Find First File” or “Find First File and Report” commands else this function will always return zero as the only occurrence will have already been found. Wildcards are usually used, so if the “Find First File” or “Find First File and Report” commands return the stringlength and filename, further tests can be made using ""Find Next File and Report"" command to find all the files that match the wildcard class."
file_exists;;0x0005;0x0005;0x0005;(const char *) filename;ack,status;filename : Name of the file(s) for search (passed as a string). Filename must be 8.3 format.;status : 1 = File found, 0 = File not found.;Tests for the existence of the file provided with the search key.
file_open;;0x000A;0x000A;0x000A;(const char *) filename, (char) mode;ack,handle;filename : Name of the file(s) for search (passed as a string). Filename must be 8.3 format. Mode : ‘r’ or ‘w’ or ‘a’ (read write, append);handle : return handle if file exists, else internal file error is set;Returns handle if file exists. The file ‘handle’ that is created is now used as reference for ‘filename’ for further file commands such as “File Close”, etc. For File Write and File Append modes ('w' and 'a') the file is created if it does not exist.
file_close;;0xFF18;0xFE51;0xFF18;handle;ack,status;handle : The file handle that was created by the “File Open” command which is now used as reference ‘handle’ for the filename, for further file functions such as in this function to close the file.;Status : 1 = file closed, 0 = file not closed;The File Close command will close the previously opened file.
file_read;;0x000C;0x000C;0x000C;size, handle;ack,n,(char)str[n];size : Number of bytes to be read. handle : The handle that references the file to be read.;count : Returns the number of bytes read. data : Data read from the file;Returns the number of bytes specified by ‘size’ from the file referenced by ‘handle’.
file_seek;;0xFF16;0xFE4F;0xFF16;handle, hiWord, loWord;ack,status;"handle The handle that references the file ;HiWord Contains the upper 16bits of the memory pointer into the file. LoWord Contains the lower 16bits of the memory pointer into the file.";Status : 1 = success, 0 = error;The File Seek command places the file pointer at the required position in a file that has been opened in 'r' (read) or 'a' (append) mode.
file_index;;0xFF15;0xFE4E ;0xFF15;handle, hiWord, loWord, recordNum;ack,status;"Handle : The handle that references the file ; HiSize : Contains the upper 16bits of the size of the file records; LoSize : Contains the lower 16bits of the size of the file records ;recordnum : The index of the required record";Status : 1 = success, 0 = error;Places the file pointer at the position in a file that has been opened in 'r' (read) or 'a' (append) mode. In append mode, File Index does not expand a filesize, instead, the file pointer (handle) is set to the end position of the file, e.g. assuming the record size is 100 bytes, the File Index command with HiSize = 0, LoSize = 100 and recordnum = 22 will set the file position to 2200 for the file handle, so subsequent data may be read from that position onwards with “Read Character from the File”, “Read Word from the File”, “Read String from the File” commands or an image can be displayed with the “Display Image (FAT)” command.
file_tell;;0x000F;0x000F;0x000F;handle;ack,status,hiWord,loWord;Handle : The handle that references the file;"Status : 1 = success, 0 = error ; HiWord Contains the upper 16bits of the value of the pointer ; LoWord Contains the lower 16bits of the value of the pointer";The File Tell command returns the current value of the file pointer.
file_write;;0x0010;0x0010;0x0010;size, (uint8_t)source[size], handle;ack,count;size : Number of bytes to be written. Maximum that can be written at one time is 512 bytes.source : String of Data without Null terminator. Handle : The handle that references the file to write.;count Returns the number of bytes written.;write chunk of data to file
file_size;;0x000E;0x000E;0x000E;handle;ack,status,hiWord,loWord;Handle : The handle that references the file;"Status : 1 = success, 0 = error ; HiWord Contains the upper 16bits of the file size ; LoWord Contains the lower 16bits of the file size";
file_image;;0xFF11;0xFE4A;0xFF11;x, y, handle;ack,errno;"x : X-position of the image to be displayed ; y : Y-position of the image to be displayed ; handle : The handle that references the file containing the image(s).";error Returns a copy of the File Error, see the “File Error” command;Display an image from the file stream at screen location specified by x, y (top left corner).If there is more than 1 image in the file, it can be accessed with the “File Seek” command
file_screenCapture;;0xFF10;0xFE49;0xFF10;x, y, width, height, handle;ack,status;"X : X-position of the image to be captured ; y : Y-position of the image to be captured ; width : Width of the area to be captured ;height : Height of the area to be captured ; handle : The handle that references the file to store the image(s)";status : 0: If the operation was successful;"The Screen Capture command saves an image of the screen shot to file at the current file position.The image can later be displayed with the “Display Image (FAT)” command. The file may beopened in append mode to accumulate multiple images. Later, the images can be displayed with the “File Seek” command. The image is saved from x, y (with respect to top left corner),and the capture area is determined by ""width"" and ""height""."
file_putC;;0x001F;0x001F;0x001F;car, handle;ack,status;car: data byte (in the LSB) about to be written, handle: The handle that references the file to be written to.;status: returns the number of bytes written successfully;"This function writes the byte specified by ""char"" to the file, at the position indicated by the associated file-position pointer (set by the “File Seek” or “File Index” commands) and advances the pointer appropriately (incremented by 1). The file must be previously opened with 'w' (write) or 'a' (append) modes."
file_getC;;0xFF0E;0xFE47;0xFF0E;handle;ack,car;handle: the handle that references the file to be read from;car: returns the data byte read from the file in the LSB;The Read Character from the File command reads a byte from the file, at the position indicated by the associated file-position pointer (set by the “File Seek” or “File Index”commands) and advances the pointer appropriately (incremented by 1). The file must be previously opened with 'r' (read) mode.
file_putW;;0xFF0D;0xFE46;0xFF0D;word, handle;ack,status;word: word about to be written, handle: The handle that references the file to be written to.;status: returns the number of bytes written successfully;"This function writes the word specified by ""word"" to the file, at the position indicated by the associated file-position pointer (set by the “File Seek” or “File Index” commands) and advances the pointer appropriately (incremented by 2). The file must be previously opened with 'w' (write) or 'a' (append) modes."
file_getW;;0xFF0C ;0xFE45 ;0xFF0C ;handle;ack,word;handle: the handle that references the file to be read from;word: returns the word read from the file in the LSB;The Read Word from the File command reads a word from the file, at the position indicated by the associated file-position pointer (set by the “File Seek” or “File Index”commands) and advances the pointer appropriately (incremented by 2). The file must be previously opened with 'r' (read) mode.
file_putS;;0x0020;0x0020;0x0020;(const char*) cstr;ack,count;data: a Null terminated string to be written to the file,handle: the handle that references the file to be written to;count: returns the number of characters written (excluding the null terminator);This function writes a null terminated string to the file, at the position indicated by the associated file-position pointer (set by the “File Seek” or “File Index” commands) and advances the pointer appropriately. The file must be previously opened with 'w' (write) or 'a' (append) modes.
file_getS;;0x0007;0x0007;0x0007;size, handle;ack,n,(char)str[n];size: the maximum number of bytes to be read from the file handle: the handle that references the file to be read from;count: returns the number of characters read from file (excluding the null teminator),data: returns the string read from the file excluding the Null terminator;"This function reads a line of text from a file at the current file position indicated by the associated file-position pointer (set by the “File Seek” or “File Index” commands) and advances the pointer appropriately. Characters are read until either a newline or an EOF is received or until the specified maximum ""size"" is reached. In all cases, the string is null terminated. The file must be previously opened with 'r' (read) mode."
file_erase;;0x0003;0x0003;0x0003;(const char *) filename;ack,status;filename: name of the file to be erased (passed as a string). Filename must be 8.3 format;status: 1=success, 0=failure;"This function erases a file on the disk. Note: If the function fails, the appropriate error number is set in the “File Error” command and will usually be error 19, ""failure during FILE search"""
file_rewind;;0xFF08;0xFE41;0xFF08;handle;ack,status;handle: the handle that references the file;status: 1=success, 0=failure;The File Rewind command resets the file pointer to the beginning of a file that has been opened in 'r' (read), 'w', or 'a' (append) mode
file_loadFunction;;0x0008;0x0008;0x0008;(const char *) filename;ack,pointer;filename:Name of the 4DGL function (filename.4FN) or application program (filename.4XE) that is about to be loaded into RAM in 8.3 format ;pointer: Returns a pointer to the memory allocation where the function has been loaded from file which can be then used as a function call;The File Load Function command allocates the RAM area to the 4FN or 4XE program, load it from the uSD card in to the RAM and return a function pointer to the allocation. The function can then be invoked just like any other function would be called via a function pointer using the “File Call Function” commands. The 4FN or 4XE program may be discarded at any time when no longer required, thus freeing its memory resources. The loaded function can be discarded with the “Memory Free” command.
file_callFunction;;0x0019;0x0019;0x0019;handle, n, args[n];ack,value;handle: The file handle that was created by the “File Load Function” n: Number of arguments args: optionals arguments;value: Returns the value from main in the called function;Call the function previously loaded through “File Load Function”. The loaded function can be discarded with the “Memory Free” command.
file_run;;0x000D;0x000D;0x000D;(const char *) filename, n, args[n];ack,value;filename: A 4FN or a 4XE file is an executable file generated when a 4DGL file is compiled, provided in 8.3 format n: number of arguments args: optional arguments;value: Returns the value from the called program; The File Run command will load the 4FN or 4XE program from the uSD card in to the RAM and execute it. Once the program is called, the Host must wait until the program finished execution. Any attempt to send further commands while the 4FN or 4XE file is executing can cause the module to reset or respond with erroneous data.
file_exec;;0x0004;0x0004;0x0004;(const char *) filename, n, args[n];ack,value;filename: A 4FN or a 4XE file is an executable file generated when a 4DGL file is compiled, provided in 8.3 format n: number of arguments args: optional arguments;value: Returns the value from the called program; The File Run command will load the 4FN or 4XE program from the uSD card in to the RAM and execute it. Once the program is called, the Host must wait until the program finished execution. Any attempt to send further commands while the 4FN or 4XE file is executing can cause the module to reset or respond with erroneous data.
file_loadImageControl;;0x0009;0x0009;0x0009;(const char *) filename1, (const char *) filename2, mode;ack,handle;"filename1: The control list filename ""*.dat"". filename2: The image filename ""*.gci"". both Created from Graphics Composer, 8.3 format. mode: [0 .. 2] (see the documentation for details)";handle: handle (pointer to the memory allocation) to the image control list that has been created. Returns NULL if function fails.;Reads a control file to create an image list. The GCI file may contain images, videos or animations built through the Graphics Composer Software tool.The GCI file is created by selecting the GCI – FAT Selected Folder option in the Built Option type. See the Graphics Composer User Guide for further details on the Graphics Composer.
file_mount;;0xFF03;0xFE3C;0xFF03;;ack,status;;status: Non-zero: If the operation successful. 0: if the attempt failed;Starts up the FAT16 disk file services and allocates a small 32 byte control block for subsequent use. When you open a file using the “File Open” command a further 512 + 44 = 556 bytes are attached to the FAT16 file control block. When you close a file using the “File Close” command, the 556 byte allocation is released leaving the 32 byte file control block. The File Mount command must be called before any other FAT16 file related functions can be used. The control block and all FAT16 file resources are completely released with the “File Unmount” command.
file_unmount;;0xFF02;0xFE3B;0xFF02;;ack;;;The “File Unmount” command releases any buffers for FAT16 and unmount the Disk FileSystem. This function is to be called to close the FAT16 file system.
file_playWAV;;0x000B;0x000B;0x000B;(const char *) filename;ack,status;filename: Name of the wav file to be opened and played. Filename must be 8.3 format.;status: If there are no errors, returns number of blocks to play (1 to 32767) If errors occurred, the following is returned 6 : can’t play this rate 5 : no data chunk found in first sector 4 : no format data 3 : no wave chunk signature 2 : bad wave file format 1 : file not found;
file_writeString;;0x0021 ;0x0021 ;0x0021 ;handle, (const char*) cstr;ack,pointer;handle: A string pointer to the memory area where the string is to be loaded. The first string would start with handle = 0, next one would use the handle = string pointer returned from the execution of the Write string earlier. string: A Null terminated string which is to be passed to the Child (4XE or 4FN) program.;pointer: Returns a pointer to the memory allocation where the string has been loaded.; Load the Memory space with the string to be used by the “File Call Function”, “File Run” and “File Execute” commands as an argument. The Memory Space for the “Read String for 4XE/4FN File” command or “Load String for 4XE/4FN File” command is pre-allocated memory, 512 bytes in size. It doesn’t need to be released.
#file_readString;;0x0022;0x0022 ;0x0022;handle;ack,str[];;; /* NOT YET IMPLEMENTED because I have not yet understood how to know the size of the returned string */
snd_volume;;0xFF00;0xFE35;0xFF00;level;ack;level: is 0 – 127;;Set the sound playback volume. Var must be in the range from 8 (min volume) to 127 (max volume). If var is less than 8, volume is set to 8, and if var > 127 it is set to 127.
snd_pitch;;0xFEFF;0xFE34;0xFEFF;rate;ack,oldRate;rate: Sample's playback rate. Minimum is 4KHz. Range is, 4000 – 65535;oldRate: Returns sample's original sample rate.;Sets the samples playback rate to a different frequency. Setting pitch to zero restores the original sample rate.
snd_bufSize;;0xFEFE;0xFE33;0xFEFE;bufferSize;ack;buffersize:Specifies the buffer size. 0 = 1024 bytes (default), 1 = 2048 bytes, 2 = 4096 bytes;;Specify the memory chunk size for the wavefile buffer, default size 1024 bytes. Depending on the sample size, memory constraints, and the sample quality, it may be beneficial to change the buffer size from the default size of 1024 bytes. This command is for control of a wav buffer, see the “Play WAV File” command
snd_stop;;0xFEFD;0xFE32;0xFEFD;;ack;;;Stop any sound that is currently playing, releasing buffers and closing any open WAV file. This command is for control of a wav buffer, see the “Play WAV File” command
snd_pause;;0xFEFC;0xFE31;0xFEFC;;ack;;;Pause any sound that is currently playing. This command is for control of a wav buffer, see the “Play WAV File” command
snd_continue;;0xFEFB;0xFE30;0xFEFB;;ack;;; Resume any sound that is currently paused by the “Sound Pause” command. This command is for control of a wav buffer, see the “Play WAV File” command
snd_playing;;0xFEFA;0xFE2F;0xFEFA;;ack,togo;;togo: Number of 512 byte blocks to go.;Returns 0 if sound has finished playing, else return number of 512 byte blocks to go. This command is for control of a wav buffer, see the “Play WAV File” command
img_setPosition;;0xFF4E;0xFE8A ;0xFF4E;handle, (int16_t) index, xpos, ypos;ack,status;handle:Pointer to the Image List., index: Index of the images in the list, xpos: Top left horizontal screen position where image is to be displayed., ypos: Top left vertical screen position where image is to be displayed.;status: 1-> If the operation successful. 0 -> if the attempt failed.;
img_enable ;;0xFF4D;0xFE89;0xFF4D;handle, (int16_t) index;ack,status;handle:Pointer to the Image List., index: Index of the images in the list. ;status: 1 -> If the operation successfull. 0 -> if the attempt failed;This command requires that an image control has been created with the “Load ImageControl” command. Enables a selected image in the image list. Returns TRUE if index was ok and function was successful. This is the default state so when the “Show Image” command is called, all the images in the list will be shown. To enable all of the images in the list at the same time set index to -1. To enable a selected image, use the image index number.
img_disable;;0xFF4C;0xFE88 ;0xFF4C;handle, (int16_t) index;ack,status;handle:Pointer to the Image List., index: Index of the images in the list. ;status: 1 -> If the operation successfull. 0 -> if the attempt failed;This function requires that an image control has been created with the “Load ImageControl” command. Disables an image in the image list. Returns TRUE if index was ok and function was successful. Use this function to turn off an image so that when the “Show Image” command is called the selected image in the list will not be shown. To disable all of the images in the list at the same time set index to -1.
img_darken;;0xFF4B;0xFE87;0xFF4B;handle, (int16_t) index;ack,status;handle:Pointer to the Image List., index: Index of the images in the list. ;status: 1 -> If the operation successfull. 0 -> if the attempt failed;This function requires that an image control has been created with the “Load ImageControl” command. Darken an image in the image list. Returns TRUE if index was ok and function was successful. Use this function to darken an image so that when the “Show Image” command is called the control will take effect. To darken all of the images in the list at the same time set index to -1. Note: This feature will take effect one time only and when the “Show Image” command is called again the darkened image will revert back to normal.
img_lighten;;0xFF4A;0xFE86;0xFF4A;handle, (int16_t) index;ack,status;handle:Pointer to the Image List., index: Index of the images in the list. ;status: 1 -> If the operation successfull. 0 -> if the attempt failed; This function requires that an image control has been created with the “Load ImageControl” command. Lighten an image in the image list. Returns TRUE if index was ok and function was successful. Use this function to lighten an image so that when the “Show Image” command is called the control will take effect. To lighten all of the images in the list at the same time set index to -1. Note: This feature will take effect one time only and when the “Show Image” command is called again the lightened image will revert back to normal.
img_setWord;;0xFF49;0xFE85;0xFF49;handle, (int16_t) index, offset, value;ack,status;handle:Pointer to the Image List., index: Index of the images in the list. offset:Offset of the required word in the image entry.2 -> xpos, 3 -> ypos, 6 -> flags, 7 -> delay, 9 -> index. value: The word to be written to the entry.;status: 1 -> If the operation successfull. 0 -> if the attempt failed;This function requires that an image control has been created with the “Load Image Control” command. Set image parameters in an image entry. Note: The “Show Image” command will now show an error box for out of range video frames. Also, if frame is set to -1, just a rectangle will be drawn in background colour to blank an image. It applies to PmmC R29 or above.
img_getWord;;0xFF48;0xFE84;0xFF48;handle, (int16_t) index, offset;ack,value;handle:Pointer to the Image List., index: Index of the images in the list. offset:Offset of the required word in the image entry.2 -> xpos, 3 -> ypos, 6 -> flags, 7 -> delay, 9 -> index. value : value corresponding to the entrie;This function requires that an image control has been created with the “Load Image Control” command. Returns the image parameters in an image entry.;
img_show;;0xFF47;0xFE83;0xFF47;handle, (int16_t) index;ack,status;handle:Pointer to the Image List., index: Index of the images in the list. ;status: 1 -> If the operation successfull. 0 -> if the attempt failed;This function requires that an image control has been created with the “Load ImageControl” command. Enable the displaying of the image entry in the image control. Returns a non-zero value if successful but return value is usually ignored.
img_setAttributes;;0xFF46;0xFE82;0xFF46;handle, (int16_t) index, value;ack,status;handle:Pointer to the Image List., index: Index of the images in the list., value: Refer to the Image Attribute Flags in the description ;status: status: 1 -> If the operation successfull. 0 -> if the attempt failed; see the documentation for detailled explanation
img_clearAttributes;;0xFF45;0xFE81;0xFF45;handle, (int16_t) index, value;ack,status;handle:Pointer to the Image List., index: Index of the images in the list., value: Refer to the Image Attribute Flags in the description ;status: status: 1 -> If the operation successfull. 0 -> if the attempt failed; see the documentation for detailled explanation
img_touched;;0xFF44;0xFE80;0xFF44;handle, (int16_t) index;ack,(int16_t)value;handle:Pointer to the Image List., index: Index of the images in the list;value: Returns image index if image touched, -1 if image not touched.;This command requires that an image control has been created with the “Load ImageControl” command. Returns index if image touched or returns -1 image not touched. If index is passed as -1 the command tests all images and returns -1 if image not touched or returns index.
img_blitComtoDisplay;0x000A;0x0023;0x0023;0x0023;x,y,width,height,(const uint16_t *) data;ack;x,y: Specifies the horizontal and vertical position of the top-left corner of the x, y image to be displayed. width: width of the image to be displayed. height: height of the image to be displayed. data[width*height]: pixel1...pixeln 16 bit pixel data to be plotted on the Display screen. 16 bit = 5bit Red, 6bit Green, 5bit Blue;;This command will BLIT (Block Image Transfer) 16 bit pixel data from the Com port on to the screen.
bus_in;;0xFFD3;;0xFFD3;;ack,busState;;; see detailed 4dsystem documentation
bus_out;;0xFFD2;;0xFFD2;busState;ack;;; see detailed 4dsystem documentation
bus_read;;0xFFCF;0xFF86;0xFFCF;;ack,busState;;; see detailed 4dsystem documentation
bus_set;;0xFFD1;;0xFFD1;dirMask;ack;;; see detailed 4dsystem documentation
bus_write;;0xFFD0;0xFF87;0xFFD0;bitfield;ack;;; see detailed 4dsystem documentation
pin_hi;;0xFFD6;0xFF8F;0xFFD6;pin;ack,status;;; see detailed 4dsystem documentation
pin_lo;;0xFFD5;0xFF8E ;0xFFD5;pin;ack,status;;; see detailed 4dsystem documentation
pin_read;;0xFFD4;0xFF8C;0xFFD4;pin;ack,status;;; see detailed 4dsystem documentation
pin_set_picaso;;0xFFD7;;0xFFD7;mode, pin;ack,status;Pin=1..7 mode = 0 .. 1 (see reference manuel);; see detailed 4dsystem documentation
pin_set_diablo;;;0xFF90;;mode, pin;ack,status;Pin = 1..16 mode = 0..6 (see reference manuel);; see detailed 4dsystem documentation