Skip to content

New Feature: Food Search 2.0 for Loop! #2329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 17 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
826d424
New Feature: Food Search 2.0 for Loop!
taylorpatterson-T1D Jul 20, 2025
bf0185a
Delete Documentation/FoodSearch 2.0 Docs/Development 1.0 Docs directory
taylorpatterson-T1D Jul 20, 2025
e9adb3a
Update project.pbxproj to ver 54
taylorpatterson-T1D Jul 21, 2025
a219b86
Delete Loop/DefaultAssets.xcassets/AI-logo-master.png
taylorpatterson-T1D Jul 21, 2025
6f6569f
Added SupportsLiveActivities to Info.plist
taylorpatterson-T1D Jul 21, 2025
42a1f47
Merge branch 'dev' of https://github.com/taylorpatterson-T1D/Loop.Foo…
taylorpatterson-T1D Jul 21, 2025
cad0593
Fix for build error on AbsorptionTimePickerRow and pbxproj file
taylorpatterson-T1D Jul 21, 2025
c850319
Added delete food item Food Details list
taylorpatterson-T1D Jul 22, 2025
23edb98
Delete Loop/Base.lproj/Main.storyboard
taylorpatterson-T1D Jul 23, 2025
ba53e75
Revert "Added SupportsLiveActivities to Info.plist"
taylorpatterson-T1D Jul 23, 2025
2dab11b
Moved isAbsorptionTimePickerRow change from /LoopKitUI back under /Loop
taylorpatterson-T1D Aug 8, 2025
a7893f4
BugFix for After AI scan, adjusting Servings does not update multi-ci…
taylorpatterson-T1D Aug 8, 2025
c95c24d
Adds a method to enable Food Search to Add Carb Entry View
taylorpatterson-T1D Aug 8, 2025
3df7bb5
AI Prompt performance improvement for Standard users
taylorpatterson-T1D Aug 8, 2025
5609b98
Bugfix: Nutriments not accurately updated when deleting food items fr…
taylorpatterson-T1D Aug 8, 2025
477ca57
Refined AI prompts, added GPT 5 as option for AI.
taylorpatterson-T1D Aug 10, 2025
97bb8d0
Set search provider defaults to best ones at onboarding
taylorpatterson-T1D Aug 11, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,4 @@ Loop\ Widget\ Extension/DerivedAssets.xcassets/*
Loop/DerivedAssetsOverride.xcassets
WatchApp/DerivedAssetsOverride.xcassets
Loop\ Widget\ Extension/DerivedAssetsOverride.xcassets
Loop.xcodeproj/project.pbxproj
191 changes: 191 additions & 0 deletions Documentation/FoodSearch 2.0 Docs/01_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
# Loop Food Search Documentation

## Overview

This directory contains comprehensive documentation for Loop's Food Search functionality, including AI-powered nutrition analysis and advanced diabetes management recommendations.

## Documentation Structure

### 📋 [End User Guide](End%20User%20Guide.md)
**Complete guide for Loop users covering:**
- Quick setup and configuration
- How to use all search methods (text, barcode, voice, camera)
- Understanding results and nutrition information
- Advanced dosing recommendations (FPU, fiber analysis, exercise considerations)
- API cost estimates and usage management
- Best practices and troubleshooting basics

**Target Audience**: Loop users, diabetes patients, caregivers

### 🔧 [Configuration and Settings](Configuration%20and%20Settings.md)
**Detailed settings reference covering:**
- All available configuration options
- API provider setup (OpenAI, Claude, Gemini)
- Security and privacy settings
- Integration with existing Loop functionality
- Performance and accessibility options

**Target Audience**: End users, setup administrators

### 🛠️ [Technical Implementation Guide](Technical%20Implementation%20Guide.md)
**Developer-focused implementation details:**
- Architecture overview and data flow
- Service layer implementation
- AI provider integration
- Advanced dosing system architecture
- Performance optimization strategies
- Security implementation
- Testing framework

**Target Audience**: Developers, contributors, technical reviewers

### 🚨 [Troubleshooting Guide](Troubleshooting%20Guide.md)
**Comprehensive problem-solving resource:**
- Common issues and solutions
- API connection troubleshooting
- Search and results problems
- Performance optimization
- Data privacy concerns
- Emergency guidance

**Target Audience**: All users, support staff

## Quick Start

### For End Users
1. Read the **[End User Guide](End%20User%20Guide.md)** for complete setup instructions
2. Follow the **Quick Setup** section to enable Food Search
3. Configure your preferred AI provider with API keys
4. Refer to **[Troubleshooting Guide](Troubleshooting%20Guide.md)** for any issues

### For Developers
1. Review **[Technical Implementation Guide](Technical%20Implementation%20Guide.md)** for architecture overview
2. Examine the codebase structure and key components
3. Review integration tests in `LoopTests/FoodSearchIntegrationTests.swift`
4. Follow development best practices outlined in the technical guide

## Key Features Covered

### Core Functionality
- ✅ Text-based food search with AI analysis
- ✅ Barcode scanner for packaged foods
- ✅ Voice search with speech-to-text
- ✅ Camera analysis for food photos
- ✅ Favorite foods management
- ✅ Multi-provider AI integration

### Advanced Features
- ✅ **Advanced Dosing Recommendations** - Research-based diabetes guidance
- ✅ **Fat-Protein Units (FPU)** - Extended insulin dosing calculations
- ✅ **Fiber Impact Analysis** - Net carb adjustments
- ✅ **Exercise Considerations** - Activity-based recommendations
- ✅ **Dynamic Absorption Timing** - Meal-specific timing guidance
- ✅ **Safety Alerts** - Important diabetes management warnings

### Integration Features
- ✅ Loop therapy settings integration
- ✅ Absorption time customization
- ✅ Nutrition circle visualization
- ✅ Progressive disclosure UI design
- ✅ Accessibility compliance

## API Provider Information

### Supported Providers

| Provider | Model | Cost Range | Strengths |
|----------|--------|------------|-----------|
| **OpenAI** | GPT-4o-mini | $0.001-0.003 | Most accurate analysis |
| **Claude** | Claude-3-haiku | $0.002-0.005 | Fast and reliable |
| **Gemini** | Gemini-1.5-flash | $0.0005-0.002 | Most cost-effective |

### Cost Estimates
- **Typical user**: $1.50-15/month (100-300 food analyses)
- **Heavy user**: $15-30/month (300+ analyses)
- **Cost optimization**: Use favorites, barcode scanner for packaged foods

## Safety and Privacy

### Data Privacy
- ✅ **Local Storage**: All analysis results stored on device only
- ✅ **No Personal Data**: No health information sent to AI providers
- ✅ **Anonymized Queries**: Food descriptions only, no user identifiers
- ✅ **Secure Communication**: TLS encryption for all API calls

### Medical Safety
- ⚠️ **Advisory Only**: All recommendations require healthcare provider review
- ⚠️ **User Judgment**: Always use clinical judgment for diabetes management
- ⚠️ **Emergency Backup**: Maintain traditional carb counting as backup method

## Version Information

**Current Version**: Loop Food Search v2.0+
**Compatibility**: iOS 14+, Loop v2.0+
**Last Updated**: July 2025

## Support Resources

### Community Support
- **Loop Facebook Groups**: User community discussions
- **Loop Forums**: Technical questions and feature discussions
- **GitHub Issues**: Bug reports and feature requests

### Professional Support
- **Healthcare Providers**: Consult for diabetes management guidance
- **Diabetes Educators**: Integration with existing therapy plans
- **Technical Support**: For persistent technical issues

### Educational Resources
- **Diabetes Research**: Links to peer-reviewed studies used in advanced features
- **FPU Education**: Comprehensive Fat-Protein Unit learning resources
- **AI Technology**: Understanding AI analysis capabilities and limitations

## Contributing

### Documentation Updates
- Submit improvements via pull requests
- Follow existing documentation style
- Update version information when making changes
- Test all examples and procedures

### Feature Development
- Review **Technical Implementation Guide** before contributing
- Follow established architecture patterns
- Add comprehensive tests for new functionality
- Update documentation for any new features

### Bug Reports
- Include specific error messages and steps to reproduce
- Specify device model, iOS version, and Loop version
- Attach relevant screenshots when helpful
- Check existing issues before submitting new reports

## Legal and Compliance

### Medical Device Considerations
- Food Search is a supportive tool, not a medical device
- Does not replace professional medical advice
- Users responsible for all diabetes management decisions
- Healthcare provider consultation recommended for therapy changes

### API Terms of Service
- Users responsible for compliance with AI provider terms
- API usage subject to provider rate limits and pricing
- Users must maintain valid API keys and billing information
- Respect provider usage policies and guidelines

### Open Source License
- Loop Food Search follows Loop's existing open source license
- Documentation available under Creative Commons license
- Contributions subject to project licensing terms

---

## Quick Links

- 📖 **[Complete End User Guide](End%20User%20Guide.md)** - Everything users need to know
- ⚙️ **[Settings Reference](Configuration%20and%20Settings.md)** - All configuration options
- 💻 **[Technical Guide](Technical%20Implementation%20Guide.md)** - Implementation details
- 🔍 **[Troubleshooting](Troubleshooting%20Guide.md)** - Problem solving resource

*For the most up-to-date information, always refer to the latest documentation in this directory.*
Loading