Giter VIP home page Giter VIP logo

rakwireless-docs's Introduction

RAK-only-gray

RAKwireless

RAKwireless is an IoT company that aims to bring all-in-one IoT solutions to the global community ranging from end node sensors to cloud computing. It is committed to delivering practical and effective IoT solutions, hence, provides high-quality IoT devices.

RAK Documentation Center

RAKwireless has a documentation center where it contains a catalog of comprehensive documents to explore and delve deeper into the potential of RAK products on the Internet of Things (IoT).

The RAK Documentation Center aims to assist every developer, entrepreneur, and enthusiast alike in building their new project and implementing IoT technology solutions. Aside from the documents of the RAK products, it contains a list of curated projects and tutorials and other supplemental information to start a new project as easy as it can be.

The files are sorted per device for a more convenient experience:

  • Quick Start Guide: a set of concise instructions in installing and deploying your device with only its core functionality in mind
  • Datasheet: comprehensive information on the device components and functionality with their technical and specific characteristics
  • Knowledge Hub: a catalog of supplemental articles and tutorials, and a compilation of pre-answered questions about the device and the technology utilized to narrow the common knowledge gaps for a more thorough understanding

Open-Source

RAK decided to make its documentation center open-source to extend its scope where experts and enthusiasts collaborate and operate at their full potential. Also, anyone can inspect for errors and inconsistencies that are beneficial to the documentation center and to the other users as well. Hence, the decision is made with these three in mind:

  • Collaboration
  • Transparency
  • Adoption

Getting Started

Prerequisites

Before you begin, make sure to install VuePress first.

Installation

  1. To install the package manager:
yarn
  1. To run a local development server:
yarn docs:dev
  1. To build static files for a local server:
yarn docs:build

If there is a yarn error in running the local server, you can either do the following:

  1. Add yarn to the Environment Variables;
  2. Use a lower version of Node.js, preferably v16.19.x.

Contribution

Contributions are highly appreciated. Feel free to dive in and follow the Contributing Guidelines.

Links

rakwireless-docs's People

Contributors

aeraterta avatar beegee-tokyo avatar carlrakwireless avatar caveman99 avatar conrad619 avatar cypressxt avatar dennisg avatar dependabot[bot] avatar drichardcarl avatar janpieper avatar jasonrj avatar josh-bi-uk avatar kneelyrac avatar knthm avatar kongduino avatar marknambatac avatar mjguzon avatar ncorrosion avatar nikolasemov21 avatar petrkr avatar phoenixpeca avatar rakarla avatar retfie avatar thhobo avatar tvelev avatar victorbalssa avatar

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

Watchers

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

rakwireless-docs's Issues

Pressing Key 1 Does not illuminate all LEDs to blue

"To configure the Button, Configuration Mode must be entered. To do that, press Key 1 for three seconds. All blue LEDs will light up and you will have confirmation in the RAK Serial Port Tool."

I have a RAK7201. I can hold that button for 3 minutes and the LEDs won't turn blue.

Thank you.

Suggestions to improve the WisDuino RAK811 evaluation board's documentation

I ran into several minor issues with the WisDuino RAK811 evaluation board's documentation that made it quite difficult to configure my endpoint correctly. Implementing the following suggestions might help to improve the documentation:

  • When configuring OTAA, the quick-start guide says to use the “DeviceProfile_OTAA” device profile in ChirpStack; however, this is not included in ChirpStack by default, and there's no mention of how it should be defined. Steps on how to properly configure the device profile should be included.
  • The quick-start guide says ChirpStack does not require the device to have an application EUI set, so I didn't change mine from the default 0x0000000000000000. Unfortunately, if this value is not changed, the device will return ERROR 82 when trying to join the network. Once I figured out what this error code meant (see my next point), I was able to work around it by setting the application EUI to a dummy value (e.g. 0x0000000000000001); I think the documentation could be improved with a note to this effect.
  • I couldn't find a listing of the AT command error codes anywhere in the RAK811 evaluation board's documentation. When my endpoint returned ERROR 82, I struggled to find out what that meant until I stumbled upon the error code table in the RAK811 breakout board's AT command manual. In my opinion, it would be better to include a link to that manual rather than the incomplete summary that's currently in the evaluation board's documentation.
  • Steps describing how to correctly configure the LoRa channels in the quick-start guide would be helpful. My working assumption is that the channels used by the endpoint should match those used by the gateway.

How to connect the rak3172 to the computer

Hi, I do have the Rak3172 development board and I'm using the example code for the board as well as the code for the gyro https://docs.rakwireless.com/Product-Categories/WisBlock/RAK12034/Quickstart/.
My problem is that I failed to get a timer interrupt working.
The Timer1 library is not working because it's a arduino library. So I thought to use bare metal programming using the cube IDE. Therefore I need to upload the code.

But how am I supposed to connect it to the board?

Or is there any timer based interrupt already implemented in Rui3?

Kind regards Dominik

About pdf document

Hi everyone,
I saw your website recently and it feels pretty good. I have a question about pdf documents.
Can you give me some tips on how to achieve this effect.
I have tried many methods recently without success.
Looking forward to your reply.
image

Paperwhite e-ink display

hi
Pinmapper :
i cant find the 14xxx E-ink display with it's board in the selection : could you pleas add it ?

thx ! :-)

Antenna radiation pattern file

Hi guys,
can you add to the documentation of all your antennas, the antenna radiation pattern file, such as ant, msi or other?

interval parameter is wrong

For RAK 7200

Current parameter: at+set_config=lora:send_interval:X
Good paramenter:at+set_config=lora:send_interval:X:Y

Set a certain channel on or off.
• X - the channel number, and you can check which channel can be set before you set it.
• Y - 0: off, 1: on

Operating Humidity on rak3172

Hi there, I'm currently working on rak3172 in a little humid condition. I was wondering what is the "Operating Humidity" for rak3172 and rak3172-t?
Thanks in advance.

RAK7258

I tried to update my firmware for RAK7258 and after that i am unable to access my gateway via WiFi as it is not showing up in available list

RAK3172 Low-Level Development patches ST firmware release

I see the instructions for RAK3172 low-level development start with the STM32WL example code, then copy a handful of files to patch the resulting project.

This means that every time you run Cube to reconfigure peripherals or the LoRa application, the files need to be patched again, because Cube over-writes them.

Also, this means that the project can not be cloned into a new project using Cube

image

I did the same thing for the RAK3172-E that I did for the Seeed LoRa-E5 Mini; I created a new STM32CubeIDE project from scratch, configuring it the same as the example code, added BSP file support for the RAK3172 (including real battery level and a bit for the RAK5005 power switch) and then merged in the example code changes in lora_app.c.

This means the project can be re-generated as desired (with the warning that one needs to modify one line of code in lora_app.c to use LocalGetBatteryLevel, this is over-written by Cube), and that new projects can be created as desired using the 'new project from existing IOC' feature.

This is still the LoRaWAN End Node Client example from ST with a few changes for my own hardware, but represents a good starting point for application development when cloned.

Initial testing has proven good so far; I invite the experts at RAK to review my BSP file changes, and I also ask you to consider referencing the still-new repo in your documentation for low-level development.

Repo:

https://github.com/danak6jq/RAK3172

Documentation on configuring mqtt broker on the gateway

Hi
First things first. Your documentation on how to integrate with AWS IoT server is fantastic.
Since you started supporting mqtt in the gateway products, can you please publish some documentation on how to integrate with mqtt brokers.

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.