capacitor-sensors
所属分类：iPhone/iOS
开发工具：kotlin
文件大小：0KB
下载次数：0
上传日期：2023-09-05 11:39:26
上 传 者：
sh-1993
说明： 电容器插件，用于访问设备中存在的每个传感器，
(Capacitor plugin to get access to every sensor present in the device,)
文件列表:
.changeset/ (0, 2023-10-30)
.changeset/config.json (271, 2023-10-30)
.changeset/large-donkeys-poke.md (68, 2023-10-30)
.eslintignore (11, 2023-10-30)
.prettierignore (11, 2023-10-30)
CHANGELOG.md (199, 2023-10-30)
CONTRIBUTING.md (1325, 2023-10-30)
SensorsPlugin.podspec (543, 2023-10-30)
android/ (0, 2023-10-30)
android/build.gradle (2271, 2023-10-30)
android/gradle.properties (987, 2023-10-30)
android/gradle/ (0, 2023-10-30)
android/gradle/wrapper/ (0, 2023-10-30)
android/gradle/wrapper/gradle-wrapper.jar (61608, 2023-10-30)
android/gradle/wrapper/gradle-wrapper.properties (223, 2023-10-30)
android/gradlew (8495, 2023-10-30)
android/gradlew.bat (2776, 2023-10-30)
android/proguard-rules.pro (751, 2023-10-30)
android/settings.gradle (128, 2023-10-30)
android/src/ (0, 2023-10-30)
android/src/androidTest/ (0, 2023-10-30)
android/src/androidTest/java/ (0, 2023-10-30)
android/src/androidTest/java/com/ (0, 2023-10-30)
android/src/androidTest/java/com/getcapacitor/ (0, 2023-10-30)
android/src/androidTest/java/com/getcapacitor/android/ (0, 2023-10-30)
android/src/androidTest/java/com/getcapacitor/android/ExampleInstrumentedTest.java (780, 2023-10-30)
android/src/main/ (0, 2023-10-30)
android/src/main/AndroidManifest.xml (82, 2023-10-30)
android/src/main/java/ (0, 2023-10-30)
android/src/main/java/com/ (0, 2023-10-30)
android/src/main/java/com/alwe/ (0, 2023-10-30)
android/src/main/java/com/alwe/plugins/ (0, 2023-10-30)
... ...
# Capacitor Plugin - Sensors
Get access to every sensor present in the device!
Supported Android version: `21+`\
Supported iOS version: `Not supported`\
Supported Browsers: `Chromium-based`
## Install
```bash
npm install @danyalwe/capacitor-sensors
npx cap sync
```
## Todos
- [x] Improve documentation, add JSDoc strings
- [ ] Add support for iOS
## Supported methods
| Name | Android | iOS | Web |
| :------------------ | :------ | :-- | :-- |
| init | | | |
| getAvailableSensors | | | |
| start | | | |
| stop | | | |
| addListener | | | |
| removeAllListeners | | | |
| requestPermissions | | | |
## Supported sensors
| Sensors | Android | iOS | Web |
| :-------------------------------- | :------ | :-- | :-- |
| **`MOTION_DETECTOR`** | | | |
| **`LINEAR_ACCELERATION`** | | | |
| **`MAGNETOMETER`** | | | |
| **`GRAVITY`** | | | |
| **`GYROSCOPE`** | | | |
| **`AMBIENT_LIGHT`** | | | |
| **`ACCELEROMETER`** | | | |
| **`ABSOLUTE_ORIENTATION`** | | | |
| **`RELATIVE_ORIENTATION`** | | | |
| **`TEMPERATURE`** | | | |
| **`GAME_ROTATION_VECTOR`** | | | |
| **`GEOMAGNETIC_ROTATION_VECTOR`** | | | |
| **`HEART_BEAT`** | | | |
| **`HEART_RATE`** | | | |
| **`POSE_6DOF`** | | | |
| **`PRESSURE`** | | | |
| **`PROXIMITY`** | | | |
| **`RELATIVE_HUMIDITY`** | | | |
| **`ROTATION_VECTOR`** | | | |
| **`SIGNIFICANT_MOTION`** | | | |
| **`STATIONARY_DETECTOR`** | | | |
| **`STEP_COUNTER`** | | | |
| **`STEP_DETECTOR`** | | | |
## API
* [`init(...)`](https://github.com/zAlweNy26/capacitor-sensors/blob/master/#init)
* [`getAvailableSensors()`](https://github.com/zAlweNy26/capacitor-sensors/blob/master/#getavailablesensors)
* [`requestPermissions(...)`](https://github.com/zAlweNy26/capacitor-sensors/blob/master/#requestpermissions)
* [`start(...)`](https://github.com/zAlweNy26/capacitor-sensors/blob/master/#start)
* [`stop(...)`](https://github.com/zAlweNy26/capacitor-sensors/blob/master/#stop)
* [`addListener(...)`](https://github.com/zAlweNy26/capacitor-sensors/blob/master/#addlistener)
* [`removeAllListeners()`](https://github.com/zAlweNy26/capacitor-sensors/blob/master/#removealllisteners)
* [Interfaces](https://github.com/zAlweNy26/capacitor-sensors/blob/master/#interfaces)
* [Type Aliases](https://github.com/zAlweNy26/capacitor-sensors/blob/master/#type-aliases)
* [Enums](https://github.com/zAlweNy26/capacitor-sensors/blob/master/#enums)
### init(...)
```typescript
init(options: SensorOptions) => Promise
```
| Param | Type |
| ------------- | ------------------------------------------------------- |
| **`options`** | SensorOptions |
**Returns:** Promise<SensorData>
--------------------
### getAvailableSensors()
```typescript
getAvailableSensors() => Promise<{ sensors: SensorType[]; }>
```
**Returns:** Promise<{ sensors: SensorType[]; }>
--------------------
### requestPermissions(...)
```typescript
requestPermissions(sensor: SensorData) => Promise
```
| Param | Type |
| ------------ | ------------------------------------------------- |
| **`sensor`** | SensorData |
**Returns:** Promise<WebPermissionStatus>
--------------------
### start(...)
```typescript
start(sensor: SensorData) => Promise
```
| Param | Type |
| ------------ | ------------------------------------------------- |
| **`sensor`** | SensorData |
--------------------
### stop(...)
```typescript
stop(sensor: SensorData) => Promise
```
| Param | Type |
| ------------ | ------------------------------------------------- |
| **`sensor`** | SensorData |
--------------------
### addListener(...)
```typescript
addListener(eventName: SensorEvent, listenerFunc: (event: SensorResult) => void) => Promise
```
| Param | Type |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`eventName`** | SensorEvent |
| **`listenerFunc`** | (event: SensorResult) => void |
**Returns:** Promise<PluginListenerHandle>
--------------------
### removeAllListeners()
```typescript
removeAllListeners() => Promise
```
--------------------
### Interfaces
#### SensorData
| Prop | Type |
| ----------- | --------------------------------------------------- |
| **`infos`** | SensorInfos |
#### SensorInfos
| Prop | Type |
| ---------------- | ------------------- |
| **`vendor`** | string |
| **`version`** | number |
| **`type`** | number |
| **`maxRange`** | number |
| **`resolution`** | number |
| **`power`** | number |
| **`minDelay`** | number |
| **`maxDelay`** | number |
#### SensorOptions
| Prop | Type |
| ----------- | --------------------------------------------------- |
| **`type`** | SensorType |
| **`delay`** | SensorDelay |
#### WebPermissionStatus
| Prop | Type |
| ---------------------------- | ----------------------------------------------------------- |
| **`accelerometer`** | PermissionState |
| **`'ambient-light-sensor'`** | PermissionState |
| **`gyroscope`** | PermissionState |
| **`magnetometer`** | PermissionState |
#### PluginListenerHandle
| Prop | Type |
| ------------ | ----------------------------------------- |
| **`remove`** | () => Promise<void> |
#### SensorResult
| Prop | Type |
| --------------- | --------------------- |
| **`accuracy`** | number |
| **`timestamp`** | number |
| **`values`** | number[] |
### Type Aliases
#### PermissionState
'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'
#### SensorEvent
keyof typeof SensorType
### Enums
#### SensorType
| Members |
| --------------------------------- |
| **`AMBIENT_LIGHT`** |
| **`ACCELEROMETER`** |
| **`TEMPERATURE`** |
| **`GAME_ROTATION_VECTOR`** |
| **`GEOMAGNETIC_ROTATION_VECTOR`** |
| **`GRAVITY`** |
| **`GYROSCOPE`** |
| **`HEART_BEAT`** |
| **`HEART_RATE`** |
| **`LINEAR_ACCELERATION`** |
| **`MAGNETOMETER`** |
| **`MOTION_DETECTOR`** |
| **`POSE_6DOF`** |
| **`PRESSURE`** |
| **`PROXIMITY`** |
| **`RELATIVE_HUMIDITY`** |
| **`ROTATION_VECTOR`** |
| **`SIGNIFICANT_MOTION`** |
| **`STATIONARY_DETECTOR`** |
| **`STEP_COUNTER`** |
| **`STEP_DETECTOR`** |
| **`ABSOLUTE_ORIENTATION`** |
| **`RELATIVE_ORIENTATION`** |
#### SensorDelay
| Members |
| ------------- |
| **`FASTEST`** |
| **`GAME`** |
| **`UI`** |
| **`NORMAL`** |
近期下载者：
相关文件：
收藏者：