Giter Club home page Giter Club logo

devdocs's Introduction


THESE DOCS ARE NOW LEGACY. PLEASE USE DOCS.HELIUM.COM AND GITHUB.COM/HELIUM/DOCS


description: The home for all Helium Network Documentation

Helium Developer Documentation

Welcome to the Helium Network

The Helium Network is the largest, public LPWAN in the United States, and enables long range, low power, bi-directional communication for any LoRaWAN compatible device.

The Helium Network is open and permissionless, and requires no up-front payments, contracts or commitments to use. Devices pay Helium Hotspot owners and other Helium Network Operators on a per-packet basis for delivering their sensors packets to the application end point.

In this developer documentation you will find examples, tutorials, specifications, and API references for building devices to run on the Helium network.

Console

Console is Helium's web-based interface for deploying and managing devices; and building flexible application-level logic into your IoT deployments.

Devices

At its core, the Helium Network exists to route data for LoRaWAN-enabled devices. Whether you're building a weather station from scratch or have a pre-built location tracker from a vendor of your choosing, we're ready for you. Head to the Devices overview to get started.

Blockchain

The Helium blockchain is what sets the Helium Network apart from other network providers. For developers, it means you can take advantage of one, unified feature set wherever Helium coverage exists. No roaming or brokering of packets required. Send data and the Network takes care of the rest.

Hotspot

The Helium Hotspot is the combination LoRaWAN router and Helium blockchain miner. There are thousands deployed in the United States (and soon across the world). If you don't have one, you can buy one here. And if you want to build your own, you absolutely should.

LongFi

The LongFi architecture combines the Helium blockchain with the LoRaWAN wireless protocol. It's an entirely unique architecture that enables developers to take advantage of better Network coverage faster.

devdocs's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

devdocs's Issues

Suggested changes to 'mining-token-rewards.md'

Starting from the top of the article. I'm not sure if this is a convention around the world when it comes to technical (ish) documents but with my past experience U.S Navy Nuclear Power Plant Operator. There are two different types of tips (what Gitbook calls them) "notes" and "warnings". "notes" are things that amplify some information but doesn't affect you personally overall. "warnings" are ones that if done improperly could lead to you or someone getting hurt. I don't think there are any potential "warnings" in regards to Helium.. however the major difference is a location in the document. "notes" go after the item it's amplifying and "warnings" come before.

TL;DR - I think the tip should go after the table.


The Tip "Rewards Change Over Time" contents might need to be cleaned up a little bit. I understand that HNT rewards are scheduled to change over time, which is currently referenced. But I believe what HIP 10 does can also be seen as the rewards changing.

Recommendation: In the above table you can see the maximum allotted rewards per reward type in accordance with HIP 10.

If you're interested in the current reward type % you can check out the Chain Variables API. (However, I think it would be cool to have a refresh button that taps into the blockchain API)

The next maximum allotted rewards change is currently scheduled for August 1, 2021.


I feel the paragraph under the table could read more like this?

"HIP10 was introduced by Helium Community Member hashc0de and was adopted by the Helium Community, HIP10 ensures that HNT is rewarded at a rate of 1:1 to the amount of Data Credits (DC) routed by any given Hotspot per epoch. In doing so the Data Network Traffic reward is proportional to the DC spent that epoch. This proportional relationship between Data Network Traffic reward type and DC is capped at 32.5% (1113.0145 HNT). Therefore, if the DC burned doesn't equal the value of 1113.0145 HNT the remaining HNT is redistributed to the Proof of Coverage (PoC) rewards groups pro-rata.

Here are a few examples to illustrate how this works in practice:"


My final suggestion is with your examples. I think it would be cool if there were tables that showed the reward break down but by Hotspot types. The reason is to help buyers be a little more educated when buying. If they saw the potential rewards for having only 1 hotspot in the area vice 3 it would help allow them to make a better judgment call when ordering the hotspots.

I think you can just show the difference between 1 hotspot, 3 hotspots (minimum earnings while being a challengee and witness), and the consensus group.

Arduino Compile Error

Following the instructions outlined in https://developer.helium.com/devices/arduino-quickstart/heltec-wifi-lora-32-v2 I receive a compile error trying to deploy the project (https://github.com/helium/longfi-arduino/blob/master/Heltec-WiFi-LoRa-32-V2/longfi-us915/longfi-us915.ino) to my Heltec ESP32 V2 board.

The specific error listed is "libraries\ESP32_LoRaWAN-master\ESP32_LoRaWAN.cpp.o:(.literal._ZL22lwan_dev_params_updatev+0x0): undefined reference to 'userChannelsMask'" on my attempts.

Any suggestions?

MQTT download packet message fails.

helium/devdocs/blob/master/console/integrations/mqtt.md indicates using -m "{"payload_raw":"encoded_string"}" but this fails.
Instead -m '{"payload_raw":"SGVsbG8sIHdvcmxkIQ==","port":1,"confirmed":true}' works for me.

Of course you may what to make it -m '{"payload_raw":"[encoded string]","port":[0:1],"confirmed":[true:false]}'

Remove color mode options

Browsers that loaded old version of the devdocs with the color mode option are still loading the old colors. We need to remove the other options so the current styles are loaded.

A documentation suggestion for the Server

You have a RED BOX around the items that need changing. Nice / Clean / Easy visual, you set me up for failure.
In the Server area, your documentation shows the Server Address is 192,168.2.12
Your text says the address should be the IP Address of your Helium Network Server.

Please delete the IP address of “192,168.2.12” replace it XXX.XXX.XXX.XXX and a NOTE that says
“YOUR HELIUM NETWORK SERVER IP ADDRESS”

I think it may help people who don't follow the instructions.

Add content about coverage and hotspot options

In device and hotspot docs, be sure to mention the following:

  • look for coverage in your area using the visualizer. if there’s no coverage, here’s how to build your own hotspot
  • “if there’s no coverage, you c an either buy a hotspot from the store, or build your own”
    Provide hotspot buy links

Add relevant images to blockchain docs

  • One large POC image just under "This is a Proof of Coverage Challenge, as seen in the Helium Network Visualizer"
  • In the Challenge Failure Modes and Score Implications, one image for each of the the subheadings (showing Target Not Challenged, Failed Challenge, and Not Challenged)
  • One nice image for the Console image of the network component section

I'm sure there are others that work here. This should get us started. Feel free to add anything else you feel is relevant and additive.

Link to page which is going away Oct 11th 2020

The Build a Hotspot docs (1) suggest a a RAK2245 Pi Hat, but:
the linked rak docs (2) say that's outdated (going away Oct 11th 2020).

The rak docs link to (3) as a successor, but:
those does don't appear to show the RAK2245 Pi Hat anywhere.

I feel like the docs should be updated before Oct 11th (to avoid a dead link), but I'm not sure where/what to point to?


(1) https://developer.helium.com/hotspot/developer-setup#example-custom-hardware
(2) https://doc.rakwireless.com/rak2245-pi-hat-edition-lorawan-gateway-concentrator-module
(3) https://docs.rakwireless.com/Product-Categories/WisHat/

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.