api/org.avmedia.gshockapi/GShockAPI

GShockAPI

This class contains all the API functions. This should the the main interface to the library.

Here is how to use it:

private val api = GShockAPI(this)

class MainActivity : AppCompatActivity() {
 override fun onCreate(savedInstanceState: Bundle?) {
     super.onCreate(savedInstanceState)
     ...
     GlobalScope.launch {
         api.waitForConnection(this)
         api.getPressedButton()
         api.getWatchName()
         api.getBatteryLevel()
         api.getTimer()
         api.getAppInfo()
         api.getHomeTime()
         api.setTime()
         ...
     }
 }
}

Constructors

GShockAPI

constructor(context: Context)

Functions

clearEvents

fun clearEvents()

Clears all events (reminders) from the watch. Up to 5 events are supported.

disconnect

fun disconnect(context: Context)

Disconnect from the watch

getAlarms

suspend fun getAlarms(): ArrayList<Alarm>

Gets the current alarms from the watch. Up to 5 alarms are supported on the watch.

getAppInfo

suspend fun getAppInfo(): String

Gets and internally sets app info to the watch. This is needed to re-enable lower-right button after the watch has been reset or BLE has been cleared. Call this function after each time the connection has been established.

getBatteryLevel

suspend fun getBatteryLevel(): Int

Get Battery level.

getDSTForWorldCities

suspend fun getDSTForWorldCities(cityNumber: Int): String

Get the Daylight Saving Time for a particular World City set on the watch. There are 6 world cities that can be stored.

getDSTWatchState

suspend fun getDSTWatchState(state: CasioIO.DTS_STATE): String

Get the DST state of the watch.

getError

suspend fun getError(): String

getEventsFromWatch

suspend fun getEventsFromWatch(): ArrayList<Event>

Gets the current events (reminders) from the watch. Up to 5 events are supported.

getHomeTime

suspend fun getHomeTime(): String

Get Home Time, (Home City).

getPressedButton

suspend fun getPressedButton(): CasioIO.WATCH_BUTTON

This function tells us which button was pressed on the watch to initiate the connection. Remember, the connection between the phone and the watch can only be initiated from the watch.

getSettings

suspend fun getSettings(): Settings

Get settings from the watch. Example:

getTimer

suspend fun getTimer(): Int

Get Timer value in seconds.

getWatchName

suspend fun getWatchName(): String

Get the name of the watch.

getWatchTemperature

suspend fun getWatchTemperature(): Int

Get Watch Temperature.

getWorldCities

suspend fun getWorldCities(cityNumber: Int): String

Get the name for a particular World City set on the watch. There are 6 world cities that can be stored.

isActionButtonPressed

fun isActionButtonPressed(): Boolean

This function tells us if the connection was initiated by short-pressing the lower-right button on the watch, also known as ACTION BUTTON

isAutoTimeStarted

fun isAutoTimeStarted(): Boolean

This function tells us if the connection was initiated automatically by the watch, without the user pressing any button. This happens if Auto-Time is set in the setting. In this case, the watch will periodically connect at around 00:30, 06:30, 12:30 and 18:30

isBluetoothEnabled

fun isBluetoothEnabled(context: Context): Boolean

Tells us if Bluetooth is currently enabled on the phone. If not, the app can take action to enable it.

isConnected

fun isConnected(): Boolean

Returns a Boolean value indicating if the watch is currently commenced to the phone

isFindPhoneButtonPressed

fun isFindPhoneButtonPressed(): Boolean

This function tells us if the connection was initiated by ling-pressing the lower-right button on the watch, used to activate FIND PHONE action

isNormalButtonPressed

fun isNormalButtonPressed(): Boolean

This function tells us if the connection was initiated by long-pressing the lower-left button on the watch

preventReconnection

fun preventReconnection(): Boolean

resetHand

fun resetHand()

sendMessage

@RequiresApi(value = 26)

fun sendMessage(message: String)

setAlarms

fun setAlarms(alarms: ArrayList<Alarm>)

Sets alarms to the watch. Up to 5 alarms are supported on the watch.

setEvents

fun setEvents(events: ArrayList<Event>)

Sets events (reminders) to the watch. Up to 5 events are supported.

setSettings

fun setSettings(settings: Settings)

Set settings to the watch. Populate a Settings and call this function. Example:

setTime

suspend fun setTime(timeZone: String = TimeZone.getDefault().id)

Sets the current time on the watch from the time on the phone. In addition, it can optionally set the Home Time to the current time zone. If timezone changes during travel, the watch will automatically be set to the correct time and timezone after running this function.

setTimer

fun setTimer(timerValue: Int)

Set Timer value in seconds.

stopScan

fun stopScan()

teardownConnection

fun teardownConnection(device: BluetoothDevice)

Close the connection and free all associated resources.

validateBluetoothAddress

fun validateBluetoothAddress(deviceAddress: String?): Boolean

waitForConnection

suspend fun waitForConnection(deviceId: String? = "", deviceName: String? = "")

This function waits for the watch to connect to the phone. When connected, it returns and emmits a ConnectionSetupComplete event, which can inform other parts of the app that the connection has taken place.