ronoth / LoStik

LoRaWAN compatible USB test device
MIT License
133 stars 39 forks source link

expand README #2

Closed vielmetti closed 5 years ago

vielmetti commented 6 years ago

Some things I'd expect to see in a README

vielmetti commented 6 years ago

Some of the details and pictures from https://www.thethingsnetwork.org/forum/t/lora-stik-rn2903-usb-device/14976 would be good to add here too.

vielmetti commented 6 years ago

Some reference to the RN2903 data sheet at http://ww1.microchip.com/downloads/en/DeviceDoc/50002390E.pdf would be useful too.

lolsborn commented 6 years ago

Thanks @vielmetti I have plans to add more example code and an updated read me in the following weeks before the CS campaign closes.

WA4OSH commented 5 years ago

Some reference to the RN2483 data sheet would also be good for EU868 users. http://ww1.microchip.com/downloads/en/devicedoc/50002346c.pdf

WA4OSH commented 5 years ago

Some reference to the PIC18F46K22 is needed https://www.microchip.com/wwwproducts/en/PIC18F46K22 http://ww1.microchip.com/downloads/en/DeviceDoc/40001412G.pdf

WA4OSH commented 5 years ago

Some reference to the LoRaWAN Library is needed: http://ww1.microchip.com/downloads/en/DeviceDoc/40001864B.pdf

WA4OSH commented 5 years ago

Your LoStik API needs to be documented send_cmd(" ")...

sys set pindig GPIO11 0
GPIO10 = blue led GPIO11 = red led 0 = off? 1 = on?

sys get ver

radio get freq radio get mod radio get sf

radio rx

radio set pwr 10

...etc.

Where are the LoRaWAN commands? Are there callbacks to handle the incoming LoRaWAN messages?

lolsborn commented 5 years ago
    Check out the command references linked to in the readme.  

On Sat, Dec 1, 2018 at 11:49 AM -0800, "Konrad Roeder" notifications@github.com wrote:

Your LoStik API needs to be documented

send_cmd(" ")...

sys set pindig GPIO11 0

GPIO10 = blue led

GPIO11 = red led

0 = off?

1 = on?

sys get ver

radio get freq

radio get mod

radio get sf

radio rx

radio set pwr 10

...etc.

Where are the LoRaWAN commands? Are there callbacks to handle the incoming LoRaWAN messages?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub, or mute the thread.

WA4OSH commented 5 years ago

@lolsborn OK ... then please document at least the action of the system commands that won't be documented in the Microdot document. For example, there's no indication in the microdot documentation as to which LEDs are connected to what ports. Yes, I can read a schematic. But, it's sometimes good to have it all in one place. Documentation does not need to be a research project for the user.

sys set pindig GPIO10 = blue led GPIO11 = red led 0 = off? 1 = on?

WA4OSH commented 5 years ago

Need a quick "sanity check" for LoStik. Here are some things that have worked for me

Installing LoRa Development Suite for (Windows, Linux, or Mac OS) ? Configure LoStik for OTAA with TTN Join ... look for accept in log

Configure Tera Term for Serial port, 56700 baud, transmit CR_LF, receive Auto, Local echo, etc. Then a couple of lines of text that verify that LoStik is running. Turn on and off the LEDs using sys set pindig GPIO10 1 (turns on blue LED) sys set pindig GPIO10 0 (turns off blue LED) sys set pindig GPIO11 1 (turns on red LED) sys set pindig GPIO11 0 (turns off red LED)

lolsborn commented 5 years ago

Try just sending "sys get ver" to start. If that doesn't return a version string then you then you may have an issue with your unit.Sending random text will also return "invalid_command". Otherwise your terminal settings look correct.

On Sat, Dec 8, 2018, at 5:28 AM, Konrad Roeder wrote:

Need a quick "sanity check" for LoStik.

Configure Tera Term for Serial port, 56700 baud, transmit CR_LF, receive Auto, Local echo, etc.> Then a couple of lines of text that verify that LoStik is running. Turn on and off the LEDs?> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub[1], or mute the thread[2].

Links:

  1. https://github.com/lolsborn/LoStik/issues/2#issuecomment-445459253
  2. https://github.com/notifications/unsubscribe-auth/AADshKnf4MvM_Dock81CCGEflLxNYXU8ks5u276NgaJpZM4VB4Mm
WA4OSH commented 5 years ago

It did not respond to the sys get ver until I talked to it with the LoRa Development Suite. I did successfully configure it for my RAK831 gateway using OTAA. I was able to join it. My next steps are to get it to send a fake temperature humidity and GPS location message that's Cayenne formatted using a Python script. I will post that Python script after it works.

lolsborn commented 5 years ago

There is a miniterm.py in examples that works well as a test terminal. If you run python miniter.py 57600 it is a good way to see if it's an issue with your existing terminal settings.

On Sat, Dec 8, 2018, at 9:29 AM, Konrad Roeder wrote:

It did not respond to the sys get ver until I talked to it with the LoRa Development Suite. I did successfully configure it for my RAK831 gateway using OTAA. I was able to join it. My next steps are to get it to send a fake temperature humidity and GPS location message that's Cayenne formatted using a Python script. I will post that Python script after it works.> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub[1], or mute the thread[2].

Links:

  1. https://github.com/lolsborn/LoStik/issues/2#issuecomment-445475790
  2. https://github.com/notifications/unsubscribe-auth/AADshJAOq8612aHca11q8xAIsYhrAeW3ks5u2_cEgaJpZM4VB4Mm
WA4OSH commented 5 years ago

I had not setup Python 3.7.1 on my machine yet and needed something quicker to check my LoStik. Next step, is of course to finish getting Python up and running.

--Konrad

On Sat, Dec 8, 2018 at 9:42 AM Lolsborn notifications@github.com wrote:

There is a miniterm.py in examples that works well as a test terminal. If you run python miniter.py 57600 it is a good way to see if it's an issue with your existing terminal settings.

On Sat, Dec 8, 2018, at 9:29 AM, Konrad Roeder wrote:

It did not respond to the sys get ver until I talked to it with the LoRa Development Suite. I did successfully configure it for my RAK831 gateway using OTAA. I was able to join it. My next steps are to get it to send a fake temperature humidity and GPS location message that's Cayenne formatted using a Python script. I will post that Python script after it works.> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub[1], or mute the thread[2].

Links:

  1. https://github.com/lolsborn/LoStik/issues/2#issuecomment-445475790
  2. https://github.com/notifications/unsubscribe-auth/AADshJAOq8612aHca11q8xAIsYhrAeW3ks5u2_cEgaJpZM4VB4Mm

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/lolsborn/LoStik/issues/2#issuecomment-445476561, or mute the thread https://github.com/notifications/unsubscribe-auth/ADUdG6BBRX_ZWdQnIWe6jTVSf_Xqd3Rzks5u2_n2gaJpZM4VB4Mm .

-- Best, Konrad

Konrad Roeder 425-444-0595 Cell 425-256-2144 Home

lolsborn commented 5 years ago

Added info about LEDs to readme and have updated docs / examples quite a bit since this ticket was initially created. I'm going to close it for now. If there are specific suggestions or PRs please open another issue.