mirror of
https://github.com/sudoxnym/saas.git
synced 2026-04-14 11:36:32 +00:00
Add files via upload
This commit is contained in:
parent
9321e724c6
commit
7097c56dc5
4 changed files with 105 additions and 29 deletions
30
CODE_OF_CONDUCT.md
Normal file
30
CODE_OF_CONDUCT.md
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
# Code of Conduct
|
||||||
|
|
||||||
|
## Contributor Covenant Code of Conduct
|
||||||
|
|
||||||
|
### Our Pledge
|
||||||
|
|
||||||
|
We as members, contributors, and leaders pledge to make participation in our
|
||||||
|
community a harassment-free experience for everyone.
|
||||||
|
|
||||||
|
### Our Standards
|
||||||
|
|
||||||
|
Examples of behavior that contributes to a positive environment:
|
||||||
|
- Using welcoming and inclusive language
|
||||||
|
- Respecting differing viewpoints and experiences
|
||||||
|
- Accepting constructive criticism gracefully
|
||||||
|
- Showing empathy toward others
|
||||||
|
|
||||||
|
Examples of unacceptable behavior:
|
||||||
|
- The use of sexualized language or imagery
|
||||||
|
- Trolling, insulting or derogatory comments
|
||||||
|
- Personal or political attacks
|
||||||
|
- Public or private harassment
|
||||||
|
- Publishing others' private information without consent
|
||||||
|
|
||||||
|
### Enforcement
|
||||||
|
|
||||||
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported
|
||||||
|
to the maintainers at sudoxnym@thearkdropship.com.
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.
|
||||||
28
CONTRIBUTING.md
Normal file
28
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,28 @@
|
||||||
|
# Contributing to SAAS - Sleep As Android Status
|
||||||
|
|
||||||
|
Thanks for helping improve the project!
|
||||||
|
|
||||||
|
## 🧰 Getting Started
|
||||||
|
|
||||||
|
1. Fork this repo
|
||||||
|
2. Clone your fork
|
||||||
|
3. Create a feature branch (`git checkout -b feature/new-thing`)
|
||||||
|
4. Make your changes and commit (`git commit -m 'Add cool thing'`)
|
||||||
|
5. Push to your fork (`git push origin feature/new-thing`)
|
||||||
|
6. Open a Pull Request on this repo
|
||||||
|
|
||||||
|
## 🛠️ Development Tips
|
||||||
|
|
||||||
|
- This integration is a custom HACS component written in Python.
|
||||||
|
- Please test your changes with valid MQTT messages using the same topic format.
|
||||||
|
- Use clear commit messages and PR descriptions.
|
||||||
|
|
||||||
|
## 🐞 Bug Reports
|
||||||
|
|
||||||
|
Before opening an issue, check existing issues and include:
|
||||||
|
- Home Assistant version
|
||||||
|
- Logs (if possible)
|
||||||
|
- Steps to reproduce
|
||||||
|
- Device details
|
||||||
|
|
||||||
|
Thanks again for your help!
|
||||||
30
DEPLOY.md
Normal file
30
DEPLOY.md
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
# 🧪 Deploying SAAS - Sleep As Android Status via HACS
|
||||||
|
|
||||||
|
## 🛠️ Pre-requisites
|
||||||
|
|
||||||
|
- Home Assistant (2023.x or newer recommended)
|
||||||
|
- HACS installed (https://hacs.xyz/)
|
||||||
|
- MQTT broker set up and working
|
||||||
|
- Android device running Sleep As Android
|
||||||
|
|
||||||
|
## 🚀 Installation Steps
|
||||||
|
|
||||||
|
1. In HACS, go to "Integrations"
|
||||||
|
2. Click the 3-dot menu > Custom repositories
|
||||||
|
3. Paste: `https://github.com/sudoxnym/saas`
|
||||||
|
4. Set Category to "Integration"
|
||||||
|
5. Click "Add"
|
||||||
|
6. Refresh, search for `SAAS - Sleep As Android Status`, and install
|
||||||
|
7. Restart Home Assistant
|
||||||
|
8. Go to Settings > Devices & Services > Add Integration > search "SAAS"
|
||||||
|
9. Configure the integration with your MQTT topic and states
|
||||||
|
|
||||||
|
## 🧪 Testing
|
||||||
|
|
||||||
|
- Trigger sleep/wake events from Sleep As Android
|
||||||
|
- Confirm sensor states update in Home Assistant
|
||||||
|
- Optional: Use HA Companion App to link button services
|
||||||
|
|
||||||
|
## 📄 More
|
||||||
|
|
||||||
|
See the [README](./README.md) for configuration, supported devices, and example automations.
|
||||||
46
LICENSE
46
LICENSE
|
|
@ -1,33 +1,21 @@
|
||||||
# License for SAAS - Sleep As Android Status Integration
|
MIT License
|
||||||
|
|
||||||
## 1. Terms
|
Copyright (c) 2025 Joseph Ayers
|
||||||
|
|
||||||
The software, "SAAS - Sleep As Android Status" (hereafter referred to as "the software"), is owned and copyrighted by @sudoxnym. The source code is available on GitHub at [SAAS Repository](https://www.github.com/sudoxnym/saas).
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
## 2. Grant of License
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
This License grants you, free of charge, the non-exclusive right to use the software for personal use only. You are not permitted to redistribute, modify, or use the software for commercial purposes without explicit permission from the copyright owner.
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
## 3. Restrictions
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
- **No Redistribution**: You may not distribute copies of the software to third parties.
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
- **No Modification**: You may not modify, adapt, translate, or create derivative works based on the software without prior written consent from the copyright owner.
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
- **No Commercial Use**: You may not use the software for commercial purposes without obtaining a license to do so from the copyright owner.
|
SOFTWARE.
|
||||||
|
|
||||||
## 4. Disclaimer of Warranty
|
|
||||||
|
|
||||||
The software is provided "AS IS", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and non-infringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.
|
|
||||||
|
|
||||||
## 5. Limitation of Liability
|
|
||||||
|
|
||||||
In no event shall the copyright owner or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.
|
|
||||||
|
|
||||||
## 6. Termination
|
|
||||||
|
|
||||||
This License is effective until terminated. You can terminate it at any time by destroying all copies of the software in your possession. It will also automatically terminate if you fail to comply with any term or condition of this License. Upon termination, you agree to destroy all copies of the software.
|
|
||||||
|
|
||||||
## 7. Miscellaneous
|
|
||||||
|
|
||||||
This License constitutes the entire agreement between the parties concerning the subject matter hereof. If any provision of this License is found to be unenforceable, that provision shall be enforced to the maximum extent permissible so as to effect the intent of the parties, and the remainder of this License shall continue in full force and effect.
|
|
||||||
|
|
||||||
By downloading, installing, or using the software, you agree to be bound by the terms of this License. If you do not agree to the terms of this License, do not download, install, or use the software.
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue