Translated NW modules documentation in English
This commit is contained in:
parent
9bc05bbf03
commit
d4dcc59d71
|
|
@ -0,0 +1,116 @@
|
|||
# Using Numworks' modules `kandinsky`, `ion` and `time` with PythonExtra
|
||||
|
||||
PythonExtra offers the possibility of using certain Numworks modules in order to make the scripts of this machine compatible as is on Casio fx-CG50 (no support on the fx9860G due to insufficient memory and lack of color screen ).
|
||||
|
||||
This is a Work in Progress (WIP) and the support is subject to extensive testing at this stage. The port concerns the Numworks `kandinsky`, `ion` and `time` modules which are machine specific and are now supported via this implementation. The `math`, `cmath`, `random` modules being identical between the `Numworks` version and the `builtins` modules of MicroPython, they are therefore not part of this implementation but are perfectly usable without modification in the scripts.
|
||||
|
||||
Note: the `turtle` and `matplotlib.pyplot` modules are not included in this implementation. It is possible to use the `turtle`, `matplotlib` and `casioplot` modules from Casio Education which are perfectly functional and provided as an example in `ports/sh/examples`.
|
||||
|
||||
|
||||
## `kandinsky`
|
||||
|
||||
The `kandinsky` module provides support for graphics primitives via high-performance `gint` routines. All the functions of this module are available:
|
||||
|
||||
- `color(r,g,b)`: Generates the value of the color r,g,b. You can also simply use a tuple to define a color: (r,g,b).
|
||||
|
||||
- `get_pixel(x,y)`: Returns the color of the pixel at x,y coordinates as a tuple (r,g,b).
|
||||
|
||||
- `set_pixel(x,y,color)`: Lights the pixel x,y of the color color.
|
||||
|
||||
- `draw_string(text,x,y,[color1],[color2])`: Displays the text at x,y coordinates. The arguments color1 (text color) and color2 (text background color) are optional.
|
||||
|
||||
- `fill_rect(x,y,width,height,color)`: Fills a rectangle of width width and height height with the color color at the point of x and y coordinates.
|
||||
|
||||
The module also offers a certain number of colors explicitly named and accessible by a character string. The following values can be used instead of the color parameters of the `kandinsky` functions:
|
||||
- "red", "r"
|
||||
- "green", "g"
|
||||
- "blue", "b"
|
||||
- "black", "k"
|
||||
- "white", "w"
|
||||
- "yellow", "y"
|
||||
- "pink"
|
||||
- "magenta"
|
||||
- "grey", "gray"
|
||||
- "purple"
|
||||
- "orange"
|
||||
- "cyan"
|
||||
- "brown"
|
||||
|
||||
The following functions are additions to take advantage of the wide screen of the fxCG and are therefore an extension of the `Kandinsky` module. They are therefore by definition not compatible with Python Numwork. These functions can be recognized by their names which all begin with `CGEXT_`:
|
||||
|
||||
- `CGEXT_Enable_Wide_Screen()`: Enables the fxCG wide screen, no settings are necessary. The x-coordinates of the physical screen can be negative to encroach on the left white stripe and greater than 319 pixels to encroach on the right white stripe;
|
||||
|
||||
- `CGEXT_Disable_Wide_Screen()`: Cancels the activation of the fxCG extended screen, no settings are necessary. The x coordinates of the physical screen will be constrained between 0 and 320 pixels. Beyond that, the route will not be carried out.
|
||||
|
||||
- `CGEXT_Is_Wide_Screen_Enabled()`: Returns `True` if the extended screen is active and `False` otherwise.
|
||||
|
||||
Note 1: after having made a plot in the extended area, it must be active to allow its deletion (typically via a call to the `fill_rect()` function with the appropriate parameters).
|
||||
|
||||
Note 2: In non-extended mode (by default when initializing the `Kandinsky` module) the screen coordinates go from (0,0) to (319,221) centered on the fxCG screen. In extended mode, the screen coordinates range from (-38,-1) to (358,223).
|
||||
|
||||
|
||||
## `ion`
|
||||
|
||||
The `ion` module gives access to the `keydown(k)` function which returns True if the key k placed as an argument is pressed and False otherwise.
|
||||
|
||||
The “conversion” of the keys between the Numworks machine and Casio fxCG50 is done according to the following mapping:
|
||||
|
||||
| Numworks | Casio fxCG50 |
|
||||
|----------|--------------|
|
||||
| KEY_LEFT | KEY_LEFT |
|
||||
| KEY_UP | KEY_UP |
|
||||
| KEY_DOWN | KEY_DOWN |
|
||||
| KEY_RIGHT | KEY_RIGHT |
|
||||
| KEY_OK | KEY_F1 |
|
||||
| KEY_BACK | KEY_EXIT |
|
||||
| KEY_HOME | KEY_MENU |
|
||||
| KEY_ONOFF | KEY_ACON |
|
||||
| KEY_SHIFT | KEY_SHIFT |
|
||||
| KEY_ALPHA | KEY_ALPHA |
|
||||
| KEY_XNT | KEY_XOT |
|
||||
| KEY_VAR | KEY_VARS |
|
||||
| KEY_TOOLBOX | KEY_OPTN |
|
||||
| KEY_BACKSPACE | KEY_DEL |
|
||||
| KEY_EXP | KEY_EXP |
|
||||
| KEY_LN | KEY_LN |
|
||||
| KEY_LOG | KEY_LOG |
|
||||
| KEY_IMAGINARY | KEY_F2 |
|
||||
| KEY_COMMA | KEY_COMMA |
|
||||
| KEY_POWER | KEY_POWER |
|
||||
| KEY_SINE | KEY_SIN |
|
||||
| KEY_COSINE | KEY_COS |
|
||||
| KEY_TANGENT | KEY_TAN |
|
||||
| KEY_PI | KEY_F3 |
|
||||
| KEY_SQRT | KEY_F4 |
|
||||
| KEY_SQUARE | KEY_SQUARE |
|
||||
| KEY_SEVEN | KEY_7 |
|
||||
| KEY_EIGHT | KEY_8 |
|
||||
| KEY_NINE | KEY_9 |
|
||||
| KEY_LEFTPARENTHESIS | KEY_LEFTP |
|
||||
| KEY_RIGHTPARENTHESIS | KEY_RIGHTP |
|
||||
| KEY_FOUR | KEY_4 |
|
||||
| KEY_FIVE | KEY_5 |
|
||||
| KEY_SIX | KEY_6 |
|
||||
| KEY_MULTIPLICATION | KEY_MUL |
|
||||
| KEY_DIVISION | KEY_DIV |
|
||||
| KEY_ONE | KEY_1 |
|
||||
| KEY_TWO | KEY_2 |
|
||||
| KEY_THREE | KEY_3 |
|
||||
| KEY_PLUS | KEY_ADD |
|
||||
| KEY_MINUS | KEY_SUB |
|
||||
| KEY_ZERO | KEY_0 |
|
||||
| KEY_DOT | KEY_DOT |
|
||||
| KEY_EE | KEY_F5 |
|
||||
| KEY_ANS | KEY_NEG |
|
||||
| KEY_EXE | KEY_EXE |
|
||||
|
||||
Note: the `keydown(k)` function can theoretically be called on `Numworks` with the corresponding key number (for example 12 for the `KEY_ONOFF` key), but this is not supported by PythonExtra. It is therefore appropriate to explicitly name the keys via their code `KEY_xxx`.
|
||||
|
||||
|
||||
## `time`
|
||||
|
||||
The `time` module gives access to two functions:
|
||||
|
||||
- `monotonic()`: Returns the clock value at the time the function is called.
|
||||
|
||||
- `sleep(t)`: Suspends execution for t seconds.
|
||||
Loading…
Reference in New Issue