README.md

Typescript Friendly React Hooks for the Fully Kiosk Browser App

This library exposes multiple react hooks that you can use to interface with your Fully Kiosk Browser App. By default the fully kiosk API is globally injected into the window object, so you could use it directly. However, this library provides a more typescript friendly interface.

How it works

Installation

Using npm:

npm install fullykiosk

or if you prefer to use the yarn package manager:

yarn add fullykiosk

Usage

Progress

Fully Kiosk API functions implemented

• getCurrentLocale()

• getIp4Address()

• getIp6Address()

• getHostname()

• getHostname6()

• getMacAddress()

• getMacAddressForInterface(interface)

• getWifiSsid()

• getWifiBssid()

• getWifiSignalLevel()

• getSerialNumber()

• getSerialNumberDeviceOwner()

• getAndroidId()

• getDeviceId()

• getDeviceName()

• getImei()

• getSimSerialNumber()

• getBatteryLevel()

• getScreenBrightness()

• getScreenOrientation()

• getDisplayWidth()

• getDisplayHeight()

• getScreenOn()

• isPlugged()

• isKeyboardVisible()

• isWifiEnabled()

• isWifiConnected()

• isNetworkConnected()

• isBluetoothEnabled()

• isScreenRotationLocked()

• getFullyVersion()

• getFullyVersionCode()

• getWebviewVersion()

• getAndroidVersion()

• getAndroidSdk()

• getDeviceModel()

• getInternalStorageTotalSpace()

• getInternalStorageFreeSpace()

• getExternalStorageTotalSpace()

• getExternalStorageFreeSpace()

• getSensorInfo()

• getSensorValue(int type)

• getSensorValues(int type)

• getAllRxBytesMobile()

• getAllTxBytesMobile()

• getAllRxBytesWifi()

• getAllTxBytesWifi()

• turnScreenOn()

• turnScreenOff()

• turnScreenOff(boolean keepAlive)

• forceSleep()

• showToast(String text)

• setScreenBrightness(float level)

• enableWifi() // In Android 10+ only with provisioned devices

• disableWifi() // In Android 10+ only with provisioned devices

• enableBluetooth()

• disableBluetooth()

• showKeyboard()

• hideKeyboard()

• openWifiSettings()

• openBluetoothSettings()

• vibrate(int millis)

• sendHexDataToTcpPort(String hexData, String host, int port)

• showNotification(String title, String text, String url, boolean highPriority) // ver. 1.33+

• log(int type, String tag, String message) // ver. 1.41+

• copyTextToClipboard(String text)

• getClipboardText()

• getClipboardHtmlText()

• deleteFile(String path)

• deleteFolder(String path) // recursive!

• emptyFolder(String path) // recursive, ver. 1.30+

• createFolder(String path) // ver. 1.42+

• getFileList(String folder) // get JSON array, ver. 1.31+

• downloadFile(String url, String dirName)

• unzipFile(String fileName) // ver. 1.40.2+

• downloadAndUnzipFile(String url, String dirName)

• bind('onDownloadSuccess','todo("$url","$dir","$code","$fileLength","$lastModified","$mimetype");')

• bind('onDownloadFailure','todo("$url","$dir","$code");')

• bind('onUnzipSuccess','todo("$url","$dir");')

• bind('onUnzipFailure','todo("$url","$dir","$message");')

• textToSpeech(String text)

• textToSpeech(String text, String locale)

• textToSpeech(String text, String locale, String engine)

• textToSpeech(String text, String locale, String engine, boolean queue)

• stopTextToSpeech()

• playVideo(String url, boolean loop, boolean showControls, boolean exitOnTouch, boolean exitOnCompletion)

• stopVideo()

• setAudioVolume(int level, int stream)

• playSound(String url, boolean loop)

• playSound(String url, boolean loop, int stream)

• stopSound()

• showPdf(String url)

• getAudioVolume(int stream)

• isWiredHeadsetOn()

• isMusicActive()

• loadStartUrl()

• setActionBarTitle(String text)

• startScreensaver()

• stopScreensaver()

• startDaydream()

• stopDaydream()

• addToHomeScreen()

• print()

• exit()

• restartApp()

• getScreenshotPngBase64()

• loadStatsCSV()

• clearCache()

• clearFormData()

• clearHistory()

• clearCookies()

• clearCookiesForUrl(String url)

• clearWebstorage()

• focusNextTab()

• focusPrevTab()

• focusTabByIndex(int index)

• getCurrentTabIndex()

• shareUrl()

• closeTabByIndex(int index)

• closeThisTab()

• getTabList()

• loadUrlInTabByIndex(int index, String url)

• loadUrlInNewTab(String url, boolean focus)

• getThisTabIndex()

• getCurrentTabIndex()

• focusThisTab()

• focusTabByIndex(int index)

• scanQrCode(String prompt, String resultUrl)

• scanQrCode(String prompt, String resultUrl, int cameraId, int timeout, boolean beepEnabled, boolean showCancelButton)

• scanQrCode(String prompt, String resultUrl, int cameraId, int timeout, boolean beepEnabled, boolean showCancelButton, boolean useFlashlight)

• bind('onQrScanSuccess','todo('$code');')

• bind('onQrScanCancelled','todo();')

• btOpenByMac(String mac)

• btOpenByUuid(String uuid)

• btOpenByName(String name)

• fully.btIsConnected()

• fully.btGetDeviceInfoJson()

• fully.btClose()

• btSendStringData(String stringData)

• btSendHexData(String hexData)

• btSendByteData(byte[] data)

• bind('onBtConnectSuccess','todo("$device");');

• bind('onBtConnectFailure','todo();');

• bind('onBtDataRead','todo("$data");');

• nfcScanStart();

• nfcScanStart(int flags, int debounceMs);

• nfcScanStop();

• bind('onNdefDiscovered','todo("$serial", "$message", "$data");');

• bind('onNfcTagDiscovered','todo("$serial", "$type", "$message", "$data");');

• bind('onNfcTagRemoved','todo("$serial");');

• bind('screenOn','todo();')

• bind('screenOff','todo();')

• bind('showKeyboard','todo();')

• bind('hideKeyboard','todo();')

• bind('networkDisconnect','todo();')

• bind('networkReconnect','todo();')

• bind('internetDisconnect','todo();')

• bind('internetReconnect','todo();')

• bind('unplugged','todo();')

• bind('pluggedAC','todo();')

• bind('pluggedUSB','todo();')

• bind('pluggedWireless','todo();')

• bind('onScreensaverStart','todo();')

• bind('onScreensaverStop','todo();')

• bind('onDaydreamStart','todo();')

• bind('onDaydreamStop','todo();')

• bind('onBatteryLevelChanged','todo();')

• bind('volumeUp','todo();')

• bind('volumeDown','todo();')

• bind('onMotion','todo();')

• bind('facesDetected','todo($number);')

• bind('onDarkness','todo();')

• bind('onMovement','todo();')

• bind('onIBeacon','todo("$id1","$id2","$id3",$distance);')

• bind('broadcastReceived','todo("$action","$extras");');

• bind('onQrScanSuccess','todo("$code","$extras");');

• startApplication(String packageName)

• startApplication(String packageName, String action, String url)

• startIntent(String url)

• broadcastIntent(String url)

• isInForeground()

• bringToForeground()

• bringToForeground(long millis)

• bringToBackground()

• installApkFile(String url)

• enableMaintenanceMode()

• disableMaintenanceMode()

• setMessageOverlay(String text)

• registerBroadcastReceiver(String action)

• unregisterBroadcastReceiver(String action)

• fully.startMotionDetection()

• stopMotionDetection()

• isMotionDetectionRunning()

• getCamshotJpgBase64()

• getFaceNumber()

• triggerMotion()

• bind('onMotion','todo();')

• fully.getStartUrl()

• fully.setStartUrl(String url)

• fully.getBooleanSetting(String key)

• fully.getStringSetting(String key)

• fully.setBooleanSetting(String key, boolean value)

• fully.setStringSetting(String key, String value)

• fully.importSettingsFile(String url)

Contributors

LICENSE

This package is licensed under the GNU Lesser General Public License.