Introduction

The methods of this class manage events appearing in Tux Droid.

Use them to get access to user actions from your program ...

Functions List

   1.3) Class : tux.event (tuxapi_class.TUXevent)
      1.3.1)    Function : tux.event.clear
      1.3.2)    Function : tux.event.remote_key_to_string
      1.3.3)    Function : tux.event.restore
      1.3.4)    Function : tux.event.store
      1.3.5)    Function : tux.event.wait_bt_pushed
      1.3.6)    Function : tux.event.wait_head_bt_pushed
      1.3.7)    Function : tux.event.wait_head_bt_released
      1.3.8)    Function : tux.event.wait_lwing_bt_pushed
      1.3.9)    Function : tux.event.wait_lwing_bt_released
      1.3.10)   Function : tux.event.wait_remote_bt
      1.3.11)   Function : tux.event.wait_rwing_bt_pushed
      1.3.12)   Function : tux.event.wait_rwing_bt_released
      1.3.13)   Function : tux.event.wait_stable_status
      1.3.14)   Function : tux.event.wait_status

Functions Details and examples

   Global variables of the class

       "on_bt_pushed" as pof           : On tux button pushed
       "on_head_bt_pushed" as pof      : On tux head button pushed
       "on_lwing_bt_pushed" as pof     : On tux left wing button pushed
       "on_rwing_bt_pushed" as pof     : On tux right wing button pushed
       "on_bt_released" as pof         : On tux button released
       "on_head_bt_released" as pof    : On tux head button released
       "on_lwing_bt_released" as pof   : On tux left wing button released
       "on_rwing_bt_released" as pof   : On tux right wing button released
       "on_remote_bt" as tuple of pof  : On remote controller button pressed
                                         param 1 : Key as integer
       "on_status" as pof              : On status arrival
       "on_remote" as pof              : On remote controller event
       "on_light_level" as pof         : On light level event
                                         param 1 : light value as integer
       "on_connected" as pof           : On api connected to tuxdaemon
       "on_disconnected" as pof        : On api disconnect from tuxdaemon
       "on_mouth_open" as pof          : On mouth open event
       "on_mouth_close" as pof         : On mouth close event
       "on_power_plugged" as pof       : On power plugged event
       "on_power_unplugged" as pof     : On power unplugged event
       "on_left_blue_led_on" as pof    : On left blue led changed to on
       "on_left_blue_led_off" as pof   : On left blue led changed to off
       "on_right_blue_led_on" as pof   : On right blue led changed to on
       "on_right_blue_led_off" as pof  : On right blue led changed to off
       "on_eyes_open" as pof           : On eyes open event
       "on_eyes_close" as pof          : On eyes close event
       "on_rf_connected" as pof        : On RF is connected
       "on_rf_disconnected" as pof     : On RF is disconnected
       "on_pong_received" as pof       : On pong status received
       "on_mouth_stop" as pof          : On mouth stop event
       "on_eyes_stop" as pof           : On eyes stop event
       "on_wings_stop" as pof          : On wings stop event
       "on_spin_stop" as pof           : On spin stop event
       (pof = pointer of function)
   
       Example of associating a function to an event:
       >>> def my_function():
       >>>     print "hello"
       >>> tux.event.on_bt_pushed=my_function
   
       Example of associating a function to a remote event:
       >>> def my_function(key):
       >>>     print "Button %s is pressed"%remote_bt_name[key]
       >>> tux.event.on_remote_bt=my_function
   
       Key constants of the remote controller:
       (K_0,K_1,K_2,K_3,K_4,K_5,K_6,K_7,K_8,K_9,K_STANDBY,
       K_MUTE,K_VOLUMEPLUS,K_VOLUMEMINUS,K_ESCAPE,K_YES,
       K_NO,K_BACKSPACE,K_STARTVOIP,K_RECEIVECALL,K_HANGUP,
       K_STAR,K_SHARP,K_RED,K_GREEN,K_BLUE,K_YELLOW,
       K_CHANNELPLUS,K_CHANNELMINUS,K_UP,K_DOWN,K_LEFT,
       K_RIGHT,K_OK,K_FASTREWIND,K_FASTFORWARD,K_PLAYPAUSE,
       K_STOP,K_RECORDING,K_PREVIOUS,K_NEXT,K_MENU,K_MOUSE,
       K_ALT)

    Functions of the class
  
      1.3.1)    Function : tux.event.clear
      
          Clear all events
      
              Example:
              >>> tux.event.clear()
          
      1.3.2)    Function : tux.event.remote_key_to_string
      
          Get the string name of a remote key value
      
              Parameters:
              "key" as integer    : key to translate to string
      
              Return a string
      
              Example:
              >>> print tux.event.remote_key_to_string(10)
          
      1.3.3)    Function : tux.event.restore
      
          Restore all events
      
              Example:
              >>> tux.event.restore()
          
      1.3.4)    Function : tux.event.store
      
          Store all events
      
              Example:
              >>> tux.event.store()
          
      1.3.5)    Function : tux.event.wait_bt_pushed
      
          Wait until a tux button is pushed
      
              Parameters:
              "time_out" as integer : Time-out in seconds
                                      (9999 = infinite wait)
      
              Return the button value as integer
              (HEAD_BT|LEFT_WING_BT|RIGHT_WING_BT|NONE_BT)
      
              Example:
              >>> tux.event.wait_bt_pushed(10)
          
      1.3.6)    Function : tux.event.wait_head_bt_pushed
      
          Wait until head button is pushed
      
              Parameters:
              "time_out" as integer : Time-out in seconds
                                      (9999 = infinite wait)
      
              Return a boolean
      
              Example:
              >>> tux.event.wait_head_bt_pushed(2)
          
      1.3.7)    Function : tux.event.wait_head_bt_released
      
          Wait until head button is released
      
              Parameters:
              "time_out" as integer : Time-out in seconds
                                      (9999 = infinite wait)
      
              Return a boolean
      
              Example:
              >>> tux.event.wait_head_bt_released(2)
          
      1.3.8)    Function : tux.event.wait_lwing_bt_pushed
      
          Wait until left wing is pushed
      
              Parameters:
              "time_out" as integer : Time-out in seconds
                                      (9999 = infinite wait)
      
              Return a boolean
      
              Example:
              >>> tux.event.wait_lwing_bt_pushed(2)
          
      1.3.9)    Function : tux.event.wait_lwing_bt_released
      
          Wait until left wing is released
      
              Parameters:
              "time_out" as integer : Time-out in seconds
                                      (9999 = infinite wait)
      
              Return a boolean
      
              Example:
              >>> tux.event.wait_lwing_bt_released(2)
          
      1.3.10)   Function : tux.event.wait_remote_bt
      
          Wait until a specified key of the remote is pressed
      
              Parameters:
              "time_out" as integer : Time-out in seconds
                                      (9999 = infinite wait)
      
              Return a boolean
      
              Example:
              >>> tux.event.wait_remote_bt(K_OK,2)
          
      1.3.11)   Function : tux.event.wait_rwing_bt_pushed
      
          Wait until right wing is pushed
      
              Parameters:
              "time_out" as integer : Time-out in seconds
                                      (9999 = infinite wait)
      
              Return a boolean
      
              Example:
              >>> tux.event.wait_rwing_bt_pushed(2)
          
      1.3.12)   Function : tux.event.wait_rwing_bt_released
      
          Wait until right wing is released
      
              Parameters:
              "time_out" as integer : Time-out in seconds
                                      (9999 = infinite wait)
      
              Return a boolean
      
              Example:
              >>> tux.event.wait_rwing_bt_released(2)
          
      1.3.13)   Function : tux.event.wait_stable_status
      
          Wait for stable status
      
              Parameters:
              "DATA_STATUS" as integer  : Desired status
              "DATA_VALUE" as integer   : Desired value
              "time_out" as integer     : Time-out in seconds
                                          (9999 = infinite wait)
              "stable_out" as integer   : Time of stable status request in seconds
      
              Return a boolean
      
              Example:
              >>> var=tux.event.wait_status(DATAS_STATUS_HEAD_PUSH_SWITCH,1,5,2)
          
      1.3.14)   Function : tux.event.wait_status
      
          Wait until the specified status arrives
      
              Parameters:
              "DATA_STATUS" as integer  : Desired status
              "DATA_VALUE" as integer   : Desired value
              "time_out" as integer     : Time-out in seconds
                                          (9999 = infinite wait)
      
              Return a boolean
      
              Example:
              >>> var=tux.event.wait_status(DATAS_STATUS_HEAD_PUSH_SWITCH,1,2)
              (see 'tuxapi_const.py' for the complete list of statuses)