Boutique Software

Locale Button Plug-in help

Requirements

Locale Button Plug-in requires Locale version 1.0 or later for operation. Locale is available on the Android Market

Capabilities

Locale Button Plug-in provides button widgets that can be installed on an Android device's home screen. These buttons can be used both as controls and as indicators. When used as controls, they are queried by Locale as Conditions and affect which Locale Situations become active. When used as indicators, Locale controls the state of the buttons as Settings. Four colored simple on/off buttons are provided as well as a very cute Maneki Neko (Welcoming Cat), which raises its paw in a friendly greeting to indicate "On".

Locale Button Plug-in works very well with the Locale Toast Plug-in, which can provide additional visual feedback when a Situation is activated or deactivated.

Installation and use

The only way to install Locale Button Plug-in is to purchase it from the Android Market. In order to use the plug-in, Locale version 1.0 or later must also be installed.

Before trying to use the plug-in within Locale, you must first create a button on the home screen. Do this by long-pressing in a blank area of the home screen until the "Add to Home screen" menu appears. Now choose "Widgets", then "Locale Button Plug-in". A page will then appear allowing you to customize the button which will be added to your home screen. You can return to this page later in order to reconfigure the buttons by launching Locale Button Plug-in directly, without using Locale. Buttons are deleted by dragging to the trash on the home screen.

The Locale Button Plug-in automatically provides an "On/Off Button" in Locale in both the "Conditions" and "Settings" sections of the Edit Situation screen. When adding a button as a Setting or Condition, you can choose from the buttons you already created on your home screen.

Configuring buttons

When a button widget is first created, you will be presented with some choices for the configuration of the button. You may also reconfigure existing buttons at any time by launching Locale Button Plug-in directly and choosing a button to configure. The following settings may be adjusted.

Name

The text that will appears underneath the button on the home screen, and in Locale for choosing which button to use.

Touch sensitive

Controls wehther the button will respond to being pressed. A touch sensitive button will change state when pressed. A button which is not touch sensitive is useful as an indicator.

Icon

Controls which icon will be used on the home screen. The colored buttons all appear the same when off, as a simple black and white double rectangle with the word Off inside. When On, they have the word On surrounded by the chosen color. Maneki Neko is a Welcoming Cat which can be used in place of the simple icons. When the cat's paw is up, in the welcoming gesture, the button is on.

Enable haptic feedback

When a button changes state, it can optionally provide feedback using the device vibrator. The button will make one short buzz when switching off and two short buzzes when switching on.

Using a button as a Condition

Click on "Add Condition" in a Locale Situation, then choose On/Off Button.

When a button is used as a Condition in a Locale Situation, the state of the button is queried in order to enable or disable a Situation. The button state may be controlled by pressing the button, or by a Situation changing the button state. (see below)

Button

Choose which already configured button on your home screen will be evaluated. Then adjust the following fields.

State

The Condition can evaluate as "true" when the button is either On or Off. Choose which button state should activate this Condition.

Using a button as a Setting

Click on "Add Setting" in a Locale Situation, then choose On/Off Button.

When a button is used as a Setting in a Locale Situation, the button's state and touch sensitivity can be changed by the Locale Situation. This feature allows a button displayed on your home screen to indicate which Situation is active, or to enable the use of a button as a control based on which Situation is active.

In each setting is a Do not change choice. When Do not change is chosen, then this setting is not affected when this situation is activated. Leave a setting as Do not change when the situation does not require changing that particular setting.

Button

Choose which already configured button on your home screen will be adjusted. Then adjust the following fields.

State

The Setting can change the button state to either On or Off. Choose the state to which the button should be changed.

Touch sensitive

Control whether the button responds to being pressed. When a button is touch sensitive, pressing the button will toggle its state. When a button is not touch sensitive, pressing the button does not change the state of the button.

Examples

These examples are short descriptions of Situations that might be useful starting points for Situations you can create.

Momentary button

  1. Purchase Locale Toast Plug-in (optional)
  2. Create a button called "Momentary Button" on your home screen. Make sure the button is touch sensitive.
  3. Create a Locale Situation called "Momentary Situation"
  4. Add an On/Off Button Condition to the Situation which tests "Momentary Button" for being "On".
  5. Add an On/Off Button Setting to the Situation which sets "Momentary Button" to be "Off".
  6. Add a Toast Setting which displays the phrase "Just a moment" (optional)

Result: When "Momentary Button" is pressed, the "Momentary Situation" briefly become active and the phrase "Just a moment" will appear on the screen. All Settings in "Momentary Situation" will be fired, but then Locale will go back to the previous Situation.

Enable K-9 Mail push functionality with a button

  1. Purchase K-9 Mail Locale Plug-in
  2. Create a button called "Push mail" on your home screen. Make sure that the button is touch sensitive.
  3. Create a Locale Situation called "Push mail"
  4. Add an On/Off Button Condition to the Situation which tests "Push mail" for being "On"
  5. Add a "K-9 Account Settings" Setting to the Situation with the All checkbox checked and "Folders to check with push" set to "Only 1st Class folders"
  6. Add a "K-9 Account Settings" Setting to your Defaults Situation with the All checkbox checked and "Folders to check with push" set to "None"

Disable K-9 Mail push with a button

In this scenario, push is enabled in the Defaults, and the button activates an alternate Situation to disable push mail.
  1. Purchase K-9 Mail Locale Plug-in
  2. Create a button called "Push mail" on your home screen. Make sure that the button is touch sensitive and use the "Maneki Neko" icon.
  3. Create a Locale Situation called "Push disable"
  4. Add an On/Off Button Condition to the Situation which tests "Push mail" for being "Off"
  5. Add a "K-9 Account Settings" Setting to the Situation with the All checkbox checked and "Folders to check with push" set to "None"
  6. Add a "K-9 Account Settings" Setting to your Defaults Situation with the "All" checkbox checked and "Folders to check with push" set to "Only 1st Class folders"

Indicate when power is being supplied from an external source

  1. Create a button called "ExtPwr" on your home screen. Make sure that the button is not touch sensitive. Make the button use the blue on/off button icon.
  2. Create a Locale Situation called "External Power"
  3. Add a Battery Condition to the Situation which tests for Plugged In.
  4. Add an On/Off Button Setting to the Situation which sets the state of "ExtPwr" to On.
  5. Add an On/Off button Setting to your Defaults Situation which sets the state of "ExtPwr" to Off.

An overridable low-battery Situation

Use this configuration to provide for turning back on functionality that is automatically disabled when the battery is low, such as all K-9 Mail folder synchronization, as illustrated in this example. A similar configuration can be created which allows overriding a reduced functionality "night time" mode.

  1. Purchase K-9 Mail Locale Plug-in
  2. Create a button called "BattOvr" on your home screen. Make sure the button is touch sensitive and use the red on/off button icon.
  3. Create a Situation called "Low Battery"
  4. Add a Battery Condition to the Situation which tests for Battery "Below 30%"
  5. Add an On/Off Button Condition to the Situation which tests "BattOvr" for being "Off"
  6. Add a Brightness Setting to the Situation which sets the display brightness to 20%.
  7. Add a "K-9 Global Settings" Setting to the Situation which sets Background to Never.
  8. Add a "K-9 Global Settings" Setting to the Defaults Situation which sets Background to "When 'Background data' is checked".

Home Contact Us About Us