Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rn0x/cordova-plugin-stepcounter
The Cordova StepCounter Plugin allows you to track steps using the device's step counter sensor. It's designed for Android and can be easily integrated into your Cordova applications.
https://github.com/rn0x/cordova-plugin-stepcounter
cordova cordova-android cordova-plugin counter fitness health pedometer step
Last synced: about 1 month ago
JSON representation
The Cordova StepCounter Plugin allows you to track steps using the device's step counter sensor. It's designed for Android and can be easily integrated into your Cordova applications.
- Host: GitHub
- URL: https://github.com/rn0x/cordova-plugin-stepcounter
- Owner: rn0x
- License: gpl-3.0
- Created: 2024-08-10T19:14:18.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-10T21:10:49.000Z (3 months ago)
- Last Synced: 2024-10-12T05:42:08.113Z (about 1 month ago)
- Topics: cordova, cordova-android, cordova-plugin, counter, fitness, health, pedometer, step
- Language: Java
- Homepage: https://www.npmjs.com/package/cordova-stepcounter
- Size: 27.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-AR.md
Awesome Lists containing this project
README
# إضافة StepCounter لـ Cordova
📝 التوثيق بالعربية
📝 English Documentation
[](https://github.com/rn0x/cordova-plugin-stepcounter/blob/main/LICENSE)
[](https://badge.fury.io/js/cordova-stepcounter)
## نظرة عامة
إضافة StepCounter لـ Cordova تتيح لك تتبع الخطوات باستخدام مستشعر عداد الخطوات في الجهاز. تم تصميمها خصيصًا لنظام Android ويمكن دمجها بسهولة في تطبيقات Cordova الخاصة بك.
## الميزات
- بدء وإيقاف عد الخطوات.
- استرجاع عدد الخطوات الحالي.
- إدارة الأذونات تلقائيًا.
## التثبيت
### إضافة الإضافة
لتثبيت إضافة StepCounter في مشروع Cordova الخاص بك، استخدم الأمر التالي:
```bash
cordova plugin add cordova-plugin-stepcounter
```
أو يمكنك تثبيتها مباشرة من مستودع الإضافة:
```bash
cordova plugin add https://github.com/rn0x/cordova-plugin-stepcounter.git
```
### إزالة الإضافة
إذا كنت بحاجة إلى إزالة الإضافة من مشروعك، استخدم الأمر التالي:
```bash
cordova plugin rm cordova-plugin-stepcounter
```
### هيكل الدليل
```
cordova-plugin-stepcounter/
├── src/
│ └── android/
│ └── StepCounter.java
├── www/
│ └── StepCounter.js
├── plugin.xml
└── package.json
```
## الاستخدام
### واجهة برمجة التطبيقات (API)
توفر الإضافة ثلاث طرق رئيسية: `start` و `stop` و `getStepCount`.
#### بدء عد الخطوات
ابدأ مستشعر عداد الخطوات وابدأ في عد الخطوات.
```javascript
cordova.plugins.stepCounter.start(
function(successMessage) {
console.log(successMessage);
},
function(errorMessage) {
console.error(errorMessage);
}
);
```
#### إيقاف عد الخطوات
إيقاف مستشعر عداد الخطوات.
```javascript
cordova.plugins.stepCounter.stop(
function(successMessage) {
console.log(successMessage);
},
function(errorMessage) {
console.error(errorMessage);
}
);
```
#### الحصول على عدد الخطوات الحالي
استرجاع عدد الخطوات الحالي.
```javascript
cordova.plugins.stepCounter.getStepCount(
function(stepCount) {
console.log("Current step count: " + stepCount);
},
function(errorMessage) {
console.error(errorMessage);
}
);
```
### دمج React
لاستخدام إضافة StepCounter في تطبيق React، يجب التأكد من أن Cordova متكامل بشكل صحيح. إليك مثال على كيفية استخدام الإضافة داخل مكون React.
#### مثال على مكون React
```javascript
import React, { useEffect, useState } from 'react';
function StepCounterComponent() {
const [stepCount, setStepCount] = useState(0);
const [isCounting, setIsCounting] = useState(false);
useEffect(() => {
document.addEventListener("deviceready", onDeviceReady, false);
return () => {
document.removeEventListener("deviceready", onDeviceReady, false);
};
}, []);
const onDeviceReady = () => {
console.log("Device is ready");
};
const startCounting = () => {
cordova.plugins.stepCounter.start(
(successMessage) => {
console.log(successMessage);
setIsCounting(true);
},
(errorMessage) => {
console.error(errorMessage);
}
);
};
const stopCounting = () => {
cordova.plugins.stepCounter.stop(
(successMessage) => {
console.log(successMessage);
setIsCounting(false);
},
(errorMessage) => {
console.error(errorMessage);
}
);
};
const fetchStepCount = () => {
cordova.plugins.stepCounter.getStepCount(
(count) => {
setStepCount(count);
},
(errorMessage) => {
console.error(errorMessage);
}
);
};
return (
عداد الخطوات
الخطوات: {stepCount}
ابدأ العد
توقف عن العد
احصل على عدد الخطوات
);
}
export default StepCounterComponent;
```
### المساهمة
#### كيفية المساهمة
نرحب بالمساهمات في إضافة StepCounter لـ Cordova. يمكنك المساهمة عن طريق:
- الإبلاغ عن الأخطاء واقتراح الميزات من خلال قضايا GitHub.
- تقديم طلبات السحب مع إصلاحات الأخطاء أو الميزات الجديدة.
#### إعداد بيئة التطوير
1. استنساخ المستودع:
```bash
git clone https://github.com/rn0x/cordova-plugin-stepcounter.git
cd cordova-plugin-stepcounter
```
2. قم بإجراء التغييرات واختبارها محليًا مع مشروع Cordova الخاص بك.
3. قدم طلب سحب مع وصف واضح لتغييراتك.
#### الترخيص
هذه الإضافة مرخصة بموجب ترخيص GPL 3.0. انظر ملف [`LICENSE`](/LICENSE) لمزيد من المعلومات.
#### التواصل
لأي استفسارات أو تعليقات، لا تتردد في فتح قضية على مستودع GitHub.