https://github.com/petruzdroba/multi-pitch-assistant
https://github.com/petruzdroba/multi-pitch-assistant
angular capacitor ionic
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/petruzdroba/multi-pitch-assistant
- Owner: petruzdroba
- License: mit
- Created: 2025-07-10T12:33:39.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-10-15T12:19:55.000Z (8 months ago)
- Last Synced: 2025-10-16T04:47:32.842Z (8 months ago)
- Topics: angular, capacitor, ionic
- Language: TypeScript
- Homepage:
- Size: 33.3 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Multi-Pitch Assistant
A mobile application for tracking and analyzing multi-pitch climbing sessions using real-time altitude monitoring and event classification.
## 📱 Overview
Multi-Pitch Assistant is an Ionic/Angular mobile application that helps climbers track their climbing sessions with automatic event detection. The app uses the device's barometer to monitor altitude changes and intelligently classifies climbing events such as falls, rests, and pitch changes.
## License
This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details.
---
## Usage
You are welcome to **use, modify, and experiment** with this project for **personal or educational purposes**.
**Commercial use is not encouraged or supported.** If you plan to use this project commercially, please **contact the author** for permission.
---
## Disclaimer
This project is provided under the MIT License. While commercial use is technically allowed, the author requests that it be used primarily for learning, personal projects, or educational purposes.
---
### Key Features
- **Real-time Altitude Monitoring**: Uses device barometer for precise altitude tracking
- **Automatic Event Classification**: Detects falls, rests, retreats, and pitch changes
- **Session Management**: Start, track, and end climbing sessions
- **Event Logging**: Manual note-taking during sessions
- **Session History**: View and analyze past climbing sessions
- **Location Tracking**: GPS coordinates for session locations
- **Cross-platform**: Built with Ionic for Android and iOS compatibility
## 🏗️ Architecture
- **Framework**: Ionic 8 with Angular 20
- **Database**: SQLite with Capacitor Community SQLite
- **Sensors**: Barometer for altitude, GPS for location
- **Platform**: Capacitor for native mobile functionality
## 🚀 Getting Started
### Prerequisites
- Node.js (v18 or higher)
- npm or yarn
- Ionic CLI (`npm install -g @ionic/cli`)
- Android Studio (for Android development)
- Xcode (for iOS development, macOS only)
### Installation
1. **Clone the repository**
```bash
git clone https://github.com/petruzdroba/multi-pitch-assistant.git
cd multi-pitch-assistant
```
2. **Install dependencies**
```bash
npm install
```
3. **Install Capacitor CLI**
```bash
npm install -g @capacitor/cli
```
### Development Setup
1. **Start the development server**
```bash
npm start
```
2. **Add Android platform**
```bash
npx cap add android
```
3. **Sync the project**
```bash
npx cap sync
```
4. **Open in Android Studio**
```bash
npx cap open android
```
### Building and Running
#### Web Development
```bash
# Start development server
npm start
# Build for production
npm run build
```
#### Android Development
```bash
# Build and sync
ionic build
npx cap sync android
# Open in Android Studio
npx cap open android
```
#### Quick Build Scripts
**Linux/macOS:**
```bash
chmod +x build_and_install_linux.sh
./build_and_install_linux.sh
```
**Windows:**
```cmd
build_and_install_windows.bat
```
## 🧪 Testing
```bash
# Run unit tests
npm test
# Run linting
npm run lint
```
## 📱 Usage
### Starting a Session
1. Open the app and tap "Start Climbing"
2. The app will begin monitoring altitude changes
3. Automatic event detection will classify your movements
### During a Session
- **Automatic Detection**: Falls, rests, and pitch changes are detected automatically
- **Manual Notes**: Tap the + button to add custom notes
- **Real-time Monitoring**: View altitude changes and events in real-time
### Ending a Session
1. Tap "End Climbing" to finish the session
2. Add session details (name, type, location, notes)
3. Session is saved to your history
### Viewing History
- Navigate to the Log tab to see past sessions
- Tap on any session to view detailed information
- Edit session details or add post-climb notes
## 🔧 Configuration
### Environment Variables
Create `src/environments/environment.prod.ts`:
```typescript
export const environment = {
production: true
};
```
### Event Classification Thresholds
The app uses configurable thresholds for event detection:
- **Fall Detection**: Minimum altitude drop (default: 0.5m)
- **Rest Detection**: Maximum altitude change (default: 0.3m)
- **Noise Filtering**: Minimum change threshold (default: 0.5m)
## 📊 Data Models
### Session
```typescript
interface Session {
id: string;
timeStart: Date;
timeEnd: Date;
events: ClimbEvent[];
name?: string;
type?: 'sport' | 'trad' | 'undefined';
location?: { latitude: number; longitude: number };
notes?: string;
completed?: boolean;
pitchCount?: number;
}
```
### Climb Event
```typescript
interface ClimbEvent {
id: string;
time: Date;
altitude?: number;
type: 'session-started' | 'session-ended' | 'fall' |
'pitch-changed' | 'rest' | 'retreat' | 'manual-note' | 'lead-started' |
'lead-ended' | 'second-started' | 'second-ended' | 'error' | 'belay' |
'barometer-reading';
notes?: string;
}
```
## 🤝 Contributing
We welcome contributions! Please follow these steps:
1. **Fork the repository**
2. **Create a feature branch**
```bash
git checkout -b feature/your-feature-name
```
3. **Make your changes**
4. **Run tests**
```bash
npm test
npm run lint
```
5. **Commit your changes**
```bash
git commit -m "Add your feature description"
```
6. **Push to your branch**
```bash
git push origin feature/your-feature-name
```
7. **Create a Pull Request**
### Development Guidelines
- Follow Angular style guide
- Write unit tests for new features
- Ensure all tests pass before submitting PR
- Update documentation for new features
- Use conventional commit messages
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🆘 Support
- **Issues**: Report bugs and request features on [GitHub Issues](https://github.com/petruzdroba/multi-pitch-assistant/issues)
- **Discussions**: Join the conversation on [GitHub Discussions](https://github.com/petruzdroba/multi-pitch-assistant/discussions)
## 🙏 Acknowledgments
- Built with [Ionic Framework](https://ionicframework.com/)
- Uses [Capacitor](https://capacitorjs.com/) for native functionality
- Altitude monitoring powered by device barometer sensors
## 📈 Roadmap
- [ ] iOS support
- [ ] Cloud sync for session data
- [ ] Advanced analytics and statistics
- [ ] Route difficulty estimation
- [ ] Social features for sharing sessions
- [ ] Offline mode improvements
- [ ] Custom event types
- [ ] Export functionality
---
**Note**: This app requires a device with a barometer sensor for altitude monitoring functionality. GPS is used for location tracking and is optional.