Community¶
Resources and guidelines for community participation.
Get Involved¶
GitHub¶
The primary hub for development and discussion:
Repository: github.com/muurk/smartap
Home Assistant Community¶
Active discussion thread with long history:
Thread: Smartap Shower Control - Getting Started with Reverse Engineering
- Hardware photos and documentation
- Early reverse engineering discussions
- Community support
- Integration ideas
Communication Channels¶
GitHub Discussions¶
github.com/muurk/smartap/discussions
The best place for questions, ideas, and community interaction:
| Category | Use For |
|---|---|
| Q&A | Setup help, troubleshooting, "how do I..." questions |
| Protocol Research | Share captured messages, discuss byte patterns, coordinate research |
| Ideas | Feature suggestions, integration ideas, future directions |
| Show and Tell | Share your working setup, success stories, photos |
| Announcements | Project updates, releases (maintainers) |
Why Discussions instead of Issues?
- Issues are for actionable bugs and feature requests
- Discussions are for questions, ideas, and conversation
- Keeps the issue tracker focused and manageable
- Better threading for back-and-forth conversation
GitHub Issues¶
github.com/muurk/smartap/issues
For specific, actionable items:
- Bug reports (something is broken)
- Feature requests (specific, well-defined features)
- Documentation issues (errors, unclear sections)
- Code problems (build failures, test failures)
How to Contribute¶
For Non-Technical Users¶
You can help even without coding skills:
- Test the software - Try features and report what works
- Document your experience - Write about your setup process
- Help others - Answer questions you know
- Spread the word - Tell others about the project
For Technical Users¶
Many ways to contribute:
- Code - Implement features, fix bugs
- Protocol documentation - Capture and document device communication
- Testing - Test edge cases and unusual configurations
- Review - Review pull requests and code
For Hardware Enthusiasts¶
Hardware-focused contributions:
- Document variants - Different device models
- Create diagrams - Wiring, connections, pinouts
- Hardware mods - Explore improvements
- Photography - Clear internal photos
For Writers¶
Documentation improvements:
- Fix errors - Typos, unclear instructions
- Add examples - More real-world examples
- Translations - Other languages
- Tutorials - Video guides, blog posts
Community Guidelines¶
Be Respectful¶
- Treat everyone with respect
- Be patient with newcomers
- Assume good intentions
- Keep discussions constructive
Be Helpful¶
- Share what you learn
- Answer questions when you can
- Point people to relevant documentation
- Provide constructive feedback
Be Collaborative¶
- Give credit to others
- Build on existing work
- Share your successes and failures
- Work together toward common goals
Showcase Your Setup¶
Share your setup:
Photos Welcome¶
- Your installed device
- JTAG setup
- Server configuration
- Home automation integration
Write-Ups Appreciated¶
- Blog posts about your experience
- Reddit posts describing your setup
- YouTube videos walking through process
- Social media shares
Tag your posts:
- #Smartap
- #IoTRepair
- #RightToRepair
Community Resources¶
Shared Knowledge Base¶
Community members have contributed:
- Hardware pin mappings
- Device photos and schematics
- Protocol captures
- Configuration examples
- Troubleshooting tips
Community Projects¶
Related projects:
- Alternative server implementations
- Web interfaces
- Mobile apps
- Home Assistant custom components
Regular Contributors¶
Thanks to our regular contributors:
(This section will be updated as the project grows)
- Project maintainers
- Code contributors
- Documentation writers
- Testers and bug reporters
Support the Project¶
- Star the GitHub repository
- Share the project with others
- Contribute code or documentation
- Help answer questions
- Test and report bugs
This is a purely volunteer effort.
Code of Conduct¶
Expected Behavior¶
- Be welcoming and inclusive
- Respect differing viewpoints
- Give and receive constructive criticism gracefully
- Focus on what's best for the community
- Show empathy toward others
Unacceptable Behavior¶
- Harassment or discriminatory language
- Trolling or insulting comments
- Personal or political attacks
- Publishing others' private information
- Other unprofessional conduct
Recognition¶
Contributors are recognized through:
- Listed in project README
- Mentioned in release notes
- Credited in documentation
- Community appreciation
Stay Updated¶
Follow project updates:
- Watch the GitHub repository
- Subscribe to release notifications
- Check documentation updates
Questions?¶
- Read the FAQ
- Search existing GitHub issues
- Ask in GitHub Discussions
- Contact maintainers
Together We Can¶
This project proves that:
- Communities can restore abandoned devices
- Open source benefits everyone
- Technical barriers can be overcome
- IoT devices don't have to die with companies