Skip to content

Commit

Permalink
README.md fixes. Fmt fix
Browse files Browse the repository at this point in the history
  • Loading branch information
lthiery committed Jun 29, 2020
1 parent dc4ebfa commit 27fc646
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![](https://travis-ci.com/helium/virtual-lorawan-device.svg?token=35YrBmyVB8LNrXzjrRop&branch=master)](https://travis-ci.com/helium/virtual-lorawan-device)
# virtual-lorawan-device
Download a compiled release [here](https://github.com/helium/virtual-lorawan-devicec/releases).
Download a compiled release [here](https://github.com/helium/virtual-lorawan-device/releases).
# Features
This utility replaces a Semtech forwarder with this utility which instantiates
one or more virtual LoRaWAN devices. You can load devices in two ways: using
Expand All @@ -22,14 +22,9 @@ override the name with CLI option) in the following format:
"transmit_delay": 10000
}
],
"gateways":
[
"112CgbghEZwMwbKUXfz9i9o4Ysxtio4ucGH24zFNYRRU6V2RtJyk"
]
}
```
You'll want to make sure the credentials match some devices on Console.
The gateways field is optional, as it is only relevant for the "state channel test" mode.

If you want to pull credentials from Console (Staging or Prod), you need
to create a file called `consolle-credentials.json` which should look like this:
Expand All @@ -43,7 +38,7 @@ to create a file called `consolle-credentials.json` which should look like this:

You may ignore the field of the console you are not using (ie: just include staging
if you are running against staging). We also limit devices to 32 by default, but
the `-m` option let's you override that.
the `--max-devices` option let's you override that.

Note, that if you want to create lots of devices on Console, you can use
[the CLI](https://github.com/helium/helium-console-cli). The command `device
Expand All @@ -52,5 +47,10 @@ care about name or credentials.
Also note that the only way to point the CLI to staging is by editing the
`.helium-console-config.toml`.

Finally, you should know that when you run the utility by using devices from console,
the devices get printed to the terminal output in a format that is friendly for
`lorawan-devices.json`. Therefore, making curated lists of certain devices after
running them from an automatic import session can be done easily.

# Miner Setup
This utility is directly compatible with [a Miner that can be easily deployed using Docker](https://developer.helium.com/blockchain/run-your-own-miner). Note that state channel test mode requires that the Miner be added to the blockchain.
This utility is directly compatible with [a Miner that can be easily deployed using Docker](https://developer.helium.com/blockchain/run-your-own-miner). Note that state channel test mode requires that the Miner be added to the blockchain.
2 changes: 1 addition & 1 deletion src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ async fn run<'a>(opt: Opt) -> Result<(), Box<dyn std::error::Error>> {
let mut devices = Vec::new();
for console_device in console_devices {
devices.push(config::Device::from_console_device(oui, console_device));
if devices.len() == opt.max_devices {
if devices.len() == opt.max_devices {
break;
}
}
Expand Down

0 comments on commit 27fc646

Please sign in to comment.