This page lists and explains the events that may be injected into the software stack by I/O device objects.
All events are represented by a dictionary of some standard and some event-specific entries as defined here.
Standard entries
All event dictionaries are expected to contain these entries.
type = 'event' A string identifying this dictionary data as an event.
what (string) This specifies the event type, usually the name given here.
sender (string) Contains the unique identification string of the sending object
Events
clock_alarm
When a timekeeping device has been configured to raise an alarm (i.e. create an event) at a certain time, it is this event it generates and feeds into the system.
what = 'clock_alarm'
cookie (string) When setting up the alarm, the requestor can hand an arbitrary string to the timekeeper that is returned when the alarm rings. By this, the reason for setting the alarm can be identified by the object processing this event.
null
A special event structure for functions that are supposed to return an event, but have decided not to generate one.
what = 'null'
sensor_value
An analog value has been measured.
what = 'sensor_value'
value (string) The value having been read, as a decimal integer's string representation.
switch_2click
A pushbutton-type toggle switch has been activated twice within a configurable short timeframe.
what = 'switch_2click'
switch_toggled
A pushbutton-type toggle switch has been activated.
what = 'switch_toggled'
THIS DATA IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DATA, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
All product and brand names mentioned on there pages and in the source code are registered names and/or trademarks of the respective owner and are mentioned for identification purposes only.
For a full copyright notice, please see this link. For imprint and contact information, please see http://www.thiemo.net/.