Skip to content

Latest commit

 

History

History
231 lines (162 loc) · 8.16 KB

README.md

File metadata and controls

231 lines (162 loc) · 8.16 KB

Contributors Forks Stargazers Issues GNU GPLv3 LinkedIn


Logo

LocalNotifications

Android push notifications for local network API server.


Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This app is meant to assist in the utility of local IOT devices. Using no 3rd party servers, so long as your IOT device is able to send a POST request to an api server you should be able to receive notifications on your phone while on your local network.

Use Cases:

  • Getting alerts to certain IOT devices without needing to pay for proprietry 3rd party servers to recieve push notifications
  • Enabling push notifications on homemade IOT devices
  • Receiving push notifications from the API of some other service

(back to top)

Built With

  • .
  • .
  • .
  • .

(back to top)

Getting Started

Prerequisites

What you will need:

  • An API server on your local network
  • An IOT type device with the ability to send a POST request
  • An Android with 13.0

Setup

This is a general setup for how to get utility from the application.

  1. Download python API server script
  2. Configure the script to return receive POST data from your IOT device(s) 
    

    3. 

  3. Configure the script to return desired data when GET request is made

    

    4. 

  4. Run the script on a network device (ideally this is a device that remains continuously on e.g. PiHole, OpenWRT Router)
    5. 

  5. Ensure the aforementioned network device has a static ip
    6. 

  6. Install the latest version of LocalNotifications from releases
    7. 



(back to top)



Usage


Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.


For more examples, please refer to the Documentation


(back to top)



Roadmap


    

  •  Add Changelog
    • 

  •  Add Custom Repeat Intervals
    • 

  •  Add Comparators for the values check of the notifications
    • 



See the open issues for a full list of proposed features (and known issues).


(back to top)



Contributing


Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.


If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!


    

  1. Fork the Project
    2. 

  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
    3. 

  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
    4. 

  4. Push to the Branch (git push origin feature/AmazingFeature)
    5. 

  5. Open a Pull Request
    6. 



(back to top)



License


Distributed under the GPL 3.0 License. See LICENSE.txt for more information.


(back to top)



Acknowledgments



(back to top)