@@ -31,19 +31,19 @@ I also created the porting of the [Numworks' Kandinsky module](https://github.co
31
31
32
32
#### battery():
33
33
* Parameters: ** No parameters**
34
- * Description: Return battery voltage
34
+ * Description: Return battery voltage * (give a fake result) *
35
35
36
36
#### battery_level():
37
37
* Parameters: ** No parameters**
38
- * Description: Return battery level
38
+ * Description: Return battery level * (give a fake result) *
39
39
40
40
#### battery_ischarging():
41
41
* Parameters: ** No parameters**
42
- * Description: Return True if the battery is charging
42
+ * Description: Return True if the battery is charging * (give a fake result) *
43
43
44
44
#### set_brightness():
45
45
* Parameters: `` level ``
46
- * Description: Set brightness level of screen
46
+ * Description: Set brightness level of screen * (do nothing) *
47
47
48
48
#### get_brightness():
49
49
* Parameters: ** No parameters**
@@ -103,17 +103,19 @@ I also created the porting of the [Numworks' Kandinsky module](https://github.co
103
103
104
104
### Environ variables
105
105
> [ !IMPORTANT]
106
- > You must make these additions before importing ion module, otherwise the changes will not take effect.
106
+ > You must make these additions before importing the ion module, otherwise the changes will not take effect.
107
107
108
- Some options can be modified by environ variables.<br >
109
- To do this, first add a compatibility check:
108
+ Some library options can be modified by environ variables.<br >
109
+ To do so, add a compatibility check and place the environ variables into :
110
110
``` python
111
111
try :
112
112
import os
113
113
" <environ variables here>"
114
114
except : pass
115
115
```
116
116
117
+ <br >
118
+
117
119
* Change starting OS (methods according to the selected os will be created): <br >
118
120
* (Option name is same as Kandinsky so that, if both libraries are present, they are synchronized)*
119
121
``` python
@@ -131,26 +133,26 @@ os.environ['ION_OS_MODE'] = '<number>'
131
133
132
134
* Enable debug mode:
133
135
``` python
134
- # Print full error stacktrace, the original pressed key and methods calls
136
+ # Print full error stacktrace, the pressed key and methods calls
135
137
os.environ[' ION_ENABLE_DEBUG' ] = ' '
136
138
```
137
139
138
140
* Disable warnings:
139
141
``` python
140
- # Will be disable all ion warnings
142
+ # Will disable all ion warnings, like not found windows or incompatibilities.
141
143
os.environ[' ION_DISABLE_WARNINGS' ] = ' '
142
144
```
143
145
144
- * Disable reading inputs only in kandinsky window (if kandinsky is not imported globally, this option is enabled by default) :
146
+ * Disable inputs reading only from the kandinsky window :
145
147
``` python
146
- # This options allow to read keyboard inputs in python console and kandinsky window
147
- # By default it just read kandinsky window (only if is focused)
148
- # Note: if is not imported globally, this option is enabled by default
148
+ # This options allow keyboard inputs reading from the python console and the kandinsky window
149
+ # By default it only reads the kandinsky window (only if focused by user )
150
+ # Note: if kandinsky is not imported globally, this option is enabled by default
149
151
os.environ[' ION_DISABLE_KANDINSKY_INPUT_ONLY' ] = ' '
150
152
```
151
153
152
- * Get keyboard inputs everywhere (not only in kandinsky window or python console):
154
+ * Get keyboard inputs everywhere (not only from kandinsky window or python console):
153
155
``` python
154
- # Allow to get inputs in entire system, like previous version of library
156
+ # Allow to get inputs from entire system, like previous version of library
155
157
os.environ[' ION_ENABLE_GET_INPUT_EVERYWHERE' ] = ' '
156
158
```
0 commit comments