Code Monkey home page Code Monkey logo

ha-narodmon's Introduction

Please ⭐ this repo if you find it useful

NarodMon.ru Cloud Integration Component for Home Assistant

GitHub Release GitHub Activity License

hacs Project Maintenance

Community Forum

Component to integrate with Narodmon.ru cloud and automatic search for the nearest sensors of the required type.

NarodMon.ru Logo

Known Limitations and Issues

  • At the moment, configuring the component is only possible through configuration.yaml. Support for configuration via Home Assistant UI will be added in the future.

Installation

Install via HACS (recommended)

  1. Have HACS installed, this will allow you to easily manage and track updates.
  2. Search for "Narodmon".
  3. Click Install below the found integration.
  4. If you want to configure component via Home Assistant UI...
    in the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Narodmon".
  5. If you want to configure component via configuration.yaml...
    follow instructions below, then restart Home Assistant.

Manual installation

  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called narodmon.
  4. Download file narodmon.zip from the latest release section in this repository.
  5. Extract all files from this archive you downloaded in the directory (folder) you created.
  6. Restart Home Assistant
  7. If you want to configure component via Home Assistant UI...
    in the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Narodmon".
  8. If you want to configure component via configuration.yaml...
    follow instructions below, then restart Home Assistant.

Configuration Examples

# Example configuration.yaml entry
narodmon:
  apikey: YOUR_NARODMON_API
  devices:
    - name: "Narodmon"
      sensors:
        - temperature
        - humidity
        - pressure

* * *

I put a lot of work into making this repo and component available and updated to inspire and help others! I will be glad to receive thanks from you — it will give me new strength and add enthusiasm:


Patreon
or support via Bitcoin or Etherium:
Bitcoin
16yfCfz9dZ8y8yuSwBFVfiAa3CNYdMh7Ts

Configuration Variables

apikey:
(string) (Required)
The API key is a unique identifier that authenticates requests associated with your project.

Note:
To obtain a key, you need to register on narodmon.ru, then open the menu item Profile-> My applications-> New key and create an API key. You can give any name to the key at your discretion.

devices:
(list) (Required)
List of virtual devices with uniform settings. See details below.

verify_ssl:
(boolean) (Optional) (Default value: True)
Verify SSL/TLS certificate for HTTPS request.

timeout:
(number) (Optional) (Default value: 10)
Timeout for the connection in seconds.

Device configuration variables

Each virtual device in a list have the following settings:

name:
(template) (Required)
Name of the device.

latitude:
(float) (Optional) (Default value: Your home zone latitude defined in your configuration)
Latitude of the center point of the sensor search area. The sensor closest to this point is always selected.

longitude:
(float) (Optional) (Default value: Your home zone longitude defined in your configuration)
Longitude of the center point of the sensor search area. The sensor closest to this point is always selected.

scan_interval:
(number) (Optional) (Default value: 3 minutes)
Minimum time interval between updates. Supported formats: scan_interval: 'HH:MM:SS', scan_interval: 'HH:MM' and Time period dictionary.

Note:
Updates more than once a minute are prohibited by Narodmon.ru and can lead to permanent blocking of your project.

sensors:
(list) (Optional) (Default value: all listed here sensor types)
Types of sensors to be created. Available types: temperature, humidity, pressure, wind_speed, wind_bearing, precipitation, illuminance, radiation, uv, pm

Track updates

You can automatically track new versions of this component and update it by HACS.

Troubleshooting

To enable debug logs use this configuration:

# Example configuration.yaml entry
logger:
  default: info
  logs:
    custom_component.narodmon: debug

... then restart HA.

Contributions are welcome!

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! 😍

Authors & contributors

The original setup of this component is by Andrey "Limych" Khrolenok.

For a full list of all authors and contributors, check the contributor's page.

License

creative commons Attribution-NonCommercial-ShareAlike 4.0 International License

See separate license file for full text.


ha-narodmon's People

Contributors

limych avatar ludeeus avatar dependabot[bot] avatar github-actions[bot] avatar iantrich avatar oncleben31 avatar matthewflamm avatar ctso avatar eseglem avatar salem84 avatar swartjean avatar eifinger avatar raman325 avatar rroller avatar tefinger avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.