Ion-numworks

This is just a little low level library for fetching keyboard input.
This is a porting of the Numworks module, and add other methods created by others OS (like Omega or Upsilon).

Installation

You can download it on pypi.org, download files of the latest release, or simply run this command to install library: pip install ion-numworks.
To install from local folder, use: pip install .

More

I also created the porting of the Numworks' Kandinsky module

API methods

Numworks and Omega methods

keydown():

• Parameters: k
• Description: Return True if the k key is pressed (not release)

Upsilon-specific methods (previous are also added)

get_keys():

• Parameters: No parameters
• Description: Get name of pressed keys

battery():

• Parameters: No parameters
• Description: Return battery voltage (give a fake result)

battery_level():

• Parameters: No parameters
• Description: Return battery level (give a fake result)

battery_ischarging():

• Parameters: No parameters
• Description: Return True if the battery is charging (give a fake result)

set_brightness():

• Parameters: level
• Description: Set brightness level of screen (do nothing)

get_brightness():

• Parameters: No parameters
• Description: Get brightness level of screen

Numworks keyboard association

Environ variables

Some library options can be modified by environ variables.
To do so, add a compatibility check and place the environ variables into:

try:
  import os
  "<environ variables here>"
except: pass

• Change starting OS (methods according to the selected os will be created):
  (Option name is same as Kandinsky so that, if both libraries are present, they are synchronized)

# '0': All methods
# '1': Numworks methods
# '2': Omega method
# '3': Upsilon methods
os.environ['KANDINSKY_OS_MODE'] = '<number>'

• Or if you don't want to synchronize the library with kandinsky, use this environ name:

os.environ['ION_OS_MODE'] = '<number>'

• Enable debug mode:

# Print full error stacktrace, the pressed key and methods calls
os.environ['ION_ENABLE_DEBUG'] = ''

• Disable warnings:

# Will disable all ion warnings, like not found windows or incompatibilities.
os.environ['ION_DISABLE_WARNINGS'] = ''

• Disable inputs reading only from the kandinsky window:

# This options allow keyboard inputs reading from the python console and the kandinsky window
# By default it only reads the kandinsky window (only if focused by user)
# Note: if kandinsky is not imported globally, this option is enabled by default
os.environ['ION_DISABLE_KANDINSKY_INPUT_ONLY'] = ''

• Get keyboard inputs everywhere (not only from kandinsky window or python console):

# Allow to get inputs from entire system, like previous version of library
os.environ['ION_ENABLE_GET_INPUT_EVERYWHERE'] = ''