1.0.0 • Published 7 months ago

gg-bluetooth-ionic-plugin v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

gg-bluetooth-ionic-plugin

Capacitor plugin for Bluetooth devices

Install

npm install gg-bluetooth-ionic-plugin
npx cap sync

API

clearDevices()

clearDevices() => Promise<{ value: boolean; }>

Returns: Promise<{ value: boolean; }>


syncDevices(...)

syncDevices(data: { devices: GGBTDevice[]; }) => Promise<{ value: boolean; }>
ParamType
data{ devices: GGBTDevice[]; }

Returns: Promise<{ value: boolean; }>


scan(...)

scan(data: { profile: GGBTUserProfile; }, callback: GGBTScanCallback) => Promise<{ value: { type: string; data: any; }; }>
ParamType
data{ profile: GGBTUserProfile; }
callbackGGBTScanCallback

Returns: Promise<{ value: { type: string; data: any; }; }>


stop(...)

stop(data: { forceStop: boolean; }) => Promise<{ value: boolean; }>
ParamType
data{ forceStop: boolean; }

Returns: Promise<{ value: boolean; }>


updateProfile(...)

updateProfile(data: { profile: GGBTUserProfile; }) => Promise<{ value: boolean; }>
ParamType
data{ profile: GGBTUserProfile; }

Returns: Promise<{ value: boolean; }>


confirmPair(...)

confirmPair(data: { device: GGBTDevice; }) => Promise<{ value: any; }>
ParamType
data{ device: GGBTDevice; }

Returns: Promise<{ value: any; }>


deleteUser(...)

deleteUser(data: { device: GGBTDevice; disconnect: boolean; }) => Promise<{ value: any; }>
ParamType
data{ device: GGBTDevice; disconnect: boolean; }

Returns: Promise<{ value: any; }>


getWifiList(...)

getWifiList(data: { device: GGBTDevice; }) => Promise<{ value: { wifi: any[]; }; }>
ParamType
data{ device: GGBTDevice; }

Returns: Promise<{ value: { wifi: any[]; }; }>


setupWifi(...)

setupWifi(data: { device: GGBTDevice; wifiConfig: GGBTWifiConfig; }) => Promise<{ value: any; }>
ParamType
data{ device: GGBTDevice; wifiConfig: GGBTWifiConfig; }

Returns: Promise<{ value: any; }>


updateSetting(...)

updateSetting(data: { device: GGBTDevice; settings: GGBTSetting[]; }) => Promise<{ value: any; }>
ParamType
data{ device: GGBTDevice; settings: GGBTSetting[]; }

Returns: Promise<{ value: any; }>


disconnectDevice(...)

disconnectDevice(data: { device: string; }) => Promise<{ value: any; }>
ParamType
data{ device: string; }

Returns: Promise<{ value: any; }>


skipDevice(...)

skipDevice(data: { device: string; }) => Promise<{ value: any; }>
ParamType
data{ device: string; }

Returns: Promise<{ value: any; }>


getUsers(...)

getUsers(data: { device: GGBTDevice; }) => Promise<{ value: any; }>
ParamType
data{ device: GGBTDevice; }

Returns: Promise<{ value: any; }>


getWifiMacAddress(...)

getWifiMacAddress(data: { device: GGBTDevice; }) => Promise<{ value: any; }>
ParamType
data{ device: GGBTDevice; }

Returns: Promise<{ value: any; }>


startFirmwareUpdate(...)

startFirmwareUpdate(data: { device: GGBTDevice; timestamp?: number; }) => Promise<{ value: any; }>
ParamType
data{ device: GGBTDevice; timestamp?: number; }

Returns: Promise<{ value: any; }>


getDeviceInfo(...)

getDeviceInfo(data: { device: GGBTDevice; }) => Promise<{ value: any; }>
ParamType
data{ device: GGBTDevice; }

Returns: Promise<{ value: any; }>


cancelWifi(...)

cancelWifi(data: { device: GGBTDevice; }) => Promise<{ value: boolean; }>
ParamType
data{ device: GGBTDevice; }

Returns: Promise<{ value: boolean; }>


updateAccount(...)

updateAccount(data: { device: GGBTDevice; }) => Promise<{ value: any; }>
ParamType
data{ device: GGBTDevice; }

Returns: Promise<{ value: any; }>


getConnectedWifiSSID(...)

getConnectedWifiSSID(data: { device: GGBTDevice; }) => Promise<{ value: any; }>
ParamType
data{ device: GGBTDevice; }

Returns: Promise<{ value: any; }>


getMeasurementLiveData(...)

getMeasurementLiveData(data: { device: GGBTDevice; }) => Promise<{ value: any; }>
ParamType
data{ device: GGBTDevice; }

Returns: Promise<{ value: any; }>


getDeviceLogs(...)

getDeviceLogs(data: { device: GGBTDevice; }) => Promise<{ value: any; }>
ParamType
data{ device: GGBTDevice; }

Returns: Promise<{ value: any; }>


clearData(...)

clearData(data: { device: GGBTDevice; dataType: ClearDataType; }) => Promise<{ value: any; }>
ParamType
data{ device: GGBTDevice; dataType: ClearDataType; }

Returns: Promise<{ value: any; }>


Interfaces

GGBTDevice

PropType
namestring
macAddressstring
broadcastIdstring
tokenstring
userNumbernumber
preferenceGGDevicePreference

GGDevicePreference

PropType
tzOffsetnumber
timeFormatstring
displayMetricsstring[]
displayNamestring
shouldMeasurePulseboolean
shouldMeasureImpedanceboolean
shouldFactoryResetboolean
wifiFotaScheduleTimenumber

GGBTUserProfile

PropType
namestring
scaleDisplayNamestring
agenumber
sexstring
unitstring
heightnumber
weightnumber
goalWeightnumber
isAthleteboolean
goalTypestring
metricsGGBTMetricConfig[]

GGBTMetricConfig

PropType
metricstring
enabledboolean

GGBTWifiConfig

PropType
ssidstring
passwordstring

GGBTSetting

PropType
keystring
valueany

Type Aliases

GGBTScanCallback

(value: any, err?: any): void

Enums

ClearDataType

MembersValue
ALL"ALL"
ACCOUNT"ACCOUNT"
HISTORY"HISTORY"
WIFI"WIFI"
SETTINGS"SETTINGS"
1.0.0

7 months ago

0.0.1

9 months ago