0.0.1 • Published 3 months ago

metawearesteps v0.0.1

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

metawear

Metawear SDK for IOS Android

Install

npm install metawear
npx cap sync

API

echo(...)

echo(options: { value: string; }) => Promise<{ value: string; }>
ParamType
options{ value: string; }

Returns: Promise<{ value: string; }>


initialize()

initialize() => Promise<null>

Initialize Permissions.

Returns: Promise<null>


search()

search() => Promise<null>

Connects to the metawear sensor.

Returns: Promise<null>


testFunc(...)

testFunc(data: DeviceOptions) => Promise<null>
ParamType
dataDeviceOptions

Returns: Promise<null>


connect(...)

connect(data: DeviceOptions) => Promise<null>

Connects to the metawear sensor.

ParamType
dataDeviceOptions

Returns: Promise<null>


connectSensor1(...)

connectSensor1(data: DeviceOptions) => Promise<ConnectedDevice>

Connects to the metawear sensor number 1.

ParamType
dataDeviceOptions

Returns: Promise<ConnectedDevice>


connectSensor2(...)

connectSensor2(data: DeviceOptions) => Promise<ConnectedDevice>

Connects to the metawear sensor number 2.

ParamType
dataDeviceOptions

Returns: Promise<ConnectedDevice>


disconnect(...)

disconnect(data: DeviceOptions) => Promise<DisconnectResult>

Disconnect metawear sensor.

ParamType
dataDeviceOptions

Returns: Promise<DisconnectResult>


startData()

startData() => Promise<null>

Start accel and gryo data streaming and on-board logging.

Returns: Promise<null>


startAccelData(...)

startAccelData(accelData?: AccelData | undefined) => Promise<null>

Start accel data streaming and on-board logging.

Listen in JS for the logging ID with: MetawearCapacitor.addListener('accelLogID', (logID) -> { ... });

Listen in JS with: MetawearCapacitor.addListener('accelData', (accel) => { ... });

ParamType
accelDataAccelData

Returns: Promise<null>


stopAccelData()

stopAccelData() => Promise<StreamData>

Returns: Promise<StreamData>


startGyroData()

startGyroData() => Promise<null>

Start gyro data streaming and on-board logging.

Listen in JS for the logging ID with: MetawearCapacitor.addListener('gyroLogID', (logID) -> { ... });

Listen in JS for data stream with: MetawearCapacitor.addListener('gyroData', (gyro) => { ... });

Returns: Promise<null>


stopGyroData()

stopGyroData() => Promise<null>

Returns: Promise<null>


stopData()

stopData() => Promise<null>

Stop data streaming and on-board logging.

Returns: Promise<null>


downloadData()

downloadData() => Promise<null>

Downloads one of the two logs from the metawear sensor.

Listen in JS for the log data with: MetawearCapacitor.addListener('logData-ID', (logData) -> { ... }); (logData"x", logData"y", logData"z" are floats.)

Listen in JS for the log progress with: MetawearCapacitor.addListener('logProgress-ID', (progress) -> { ... }); (progress"progress" is a number between 0 and 1.)

Listen in JS for log finish with: MetawearCapacitor.addListener('logFinished-ID', () => { ... });

Returns: Promise<null>


stopLogs()

stopLogs() => Promise<null>

Stop on-board logging.

Returns: Promise<null>


checkSensorsConnections()

checkSensorsConnections() => Promise<null>

Check for the connections status of both sensors

Returns: Promise<null>


reconnectSensors()

reconnectSensors() => Promise<null>

Reconnect both sensors

Returns: Promise<null>


reconnectSensor1()

reconnectSensor1() => Promise<resultConnection>

Reconnect sensors2

Returns: Promise<resultConnection>


reconnectSensor2()

reconnectSensor2() => Promise<resultConnection>

Reconnect sensor1

Returns: Promise<resultConnection>


downloadDataSensor1()

downloadDataSensor1() => Promise<BoardData>

Download Sensor1

Returns: Promise<BoardData>


downloadDataSensor2()

downloadDataSensor2() => Promise<BoardData>

Download Sensor2

Returns: Promise<BoardData>


disconnectSensor2()

disconnectSensor2() => Promise<DisconnectResult>

Download Sensor2

Returns: Promise<DisconnectResult>


disconnectSensor1()

disconnectSensor1() => Promise<DisconnectResult>

Download Sensor2

Returns: Promise<DisconnectResult>


Interfaces

DeviceOptions

PropType
freqnumber
namestring
macstring

ConnectedDevice

PropType
batterynumber

DisconnectResult

PropType
resultboolean

AccelData

PropType
timenumber

StreamData

PropType
sensor1BoardData
sensor2BoardData

BoardData

PropType
x_accelnumber[]
y_accelnumber[]
z_accelnumber[]
timestamp_accelstring[]
x_gyronumber[]
y_gyronumber[]
z_gyronumber[]
timestamp_gyrostring[]

resultConnection

PropType
connectedboolean
0.0.1

3 months ago