Getting Started XK01

From XinaBox Wiki!
Jump to: navigation, search

Assembly

Quick Start Rules

There are only 2 rules:

  1. All the xChips has to face the same way up. Make sure you can read the name of the xChip on the same side.
    CorrectSmall.png UpsideDown.png
  2. Any side of an xChip will fit (typically) 2 other sides, but not all 4 of another xChip. Make sure the notches are matching.
    AllignmentCorrect.png AllignmentWrong.png

Assembling your Weather Station

Below is a short clip illustrating how to assemble your XK01 weather station

Downloading the Application

xFlasher

xFlasher is an application we have developed that allows you to easily upload code examples and firmware for the XinaBox CW01 core. xFlasher runs on both Windows and Mac operating systems. Using xFlasher eliminates the need for anything more than basic computer literacy to get started with the XinaBox xCHIPs. It allows you to almost effortlessly upload your code so experimentation can begin!

Download xFlasher application

Mac

Method 1
Download from the Mac App Store:
App-store.svg
Method 2
Download and install the XinaBox Flasher from https://github.com/xinabox/XinaBoxFlasher/releases/latest. Choose the .pkg for Apple Mac OS.

Windows

Download and install the XinaBox Flasher from https://github.com/xinabox/XinaBoxFlasher/releases/latest. Choose the .exe for Microsoft Windows.

For additional information on the XinaBox xFlasher, link to this page - XFlasher Usage.

Downloading the firmware file required for xFlasher

Please note: Provisioning with the xFlasher sets initial parameters for your XK01 kit. You are able to reconfigure these parameters using our Captive Portal and reconfigure the WiFi using our xZeroTouch iOS app


To provision and flash the XK01 firmware follow these simple steps
  • Insert the IP01 into your computer's USB port as shown on the right
    IP01-PC1.png
  • Select the .bin file you downloaded previously by clicking the magnifying glass icon in the top right corner
  • To start Provisioning, click FLASH
    • The first pop-up will be to "Choose a Mode of Operation", select "ONLINE" if you wish to use the dashboard and/or Blynk.
    • The next step is to enter your SSID(WiFi Network Name), click OK then enter your WiFi Password(PSK) and OK
    • After WiFi credentials you will have to enter a "Device Name" of your choosing, choose a name that makes it easy to find your device on the Data Dashboard later. Be sure to only user lowercase letters, numbers and underscores. Do not use any other characters or spaces.
    • Enter the Organization you belong to.
    • Select the MQTT Server you wish to publish to, in most cases it will be the XinaBox, if you want to use our Dashboard.
    • Lastly enter your Blynk Auth Token if you wish to configure Blynk, if not you can just skip it by clicking OK.
  • The upload process will begin and the green and blue LEDs should be illuminated on your IP01.
  • When the upload is complete the Serial Monitor will begin display data similar to what you see below

Reconfiguration of your XK01 kit without reprogramming

Captive Portal

You are able to reconfigure your device with the Captive Portal once you have power-cycled your CW01
  • Once you have turned on the CW01 again, you have 2 minutes within which you can connect to the CW01 via the Captive Portal, after those 2 minutes the device will attempt to connect to the WiFi it was previously connected to.
Connect to ☒CHIP CW01
  • Connect to the CW01 WiFi hotspot within those 2 min: XINABOX_<number> the password is password.
Configuration
  • A captive portal will normally pop up, but if not, use the device's browser and enter the address http://192.168.4.1 .
  • Complete the following fields in "Configure Device" if you wish to change anything besides the WiFi credentials and then save the fields.
    • "Device Name": If you wish to change the name of your device to make it easier to find in the Dashboard for example.
    • "Organisation Name": if it has changed.
    • You may leave "Index" as "smallsat".
    • For the "STEM Server" please select XinaBox in the drop down if you wish to publish to our dashboard. If you are part of the Virginia Space Program please select the Thinsat STEM Server.
    • Click save.
Next the options Configure WiFi and Configure Blynk will pop up
  • Select Blynk if you wish to configure Blynk, note that this requires a Blynk account, see Blynk functionality.
  • If you don't need to configure Blynk to end the process click Configure WiFi and enter your WiFi credentials to reconfigure the WiFi.
  • When successfully connected, the OLED display on the OD01 ☒CHIP will show connectivity information for 1 min, before collecting data.

xZeroTouch

xZeroTouch is an iOS app designed to reconfigure WiFi by connecting your chosen amount of cores to the WiFi that your device is connected to.

xZeroTouch will only launch if WiFi credentials are not found after the initial 2 minutes has passed for the Captive Portal. xZeroTouch will then run for approximately 1 minute there after. If xZeroTouch does not connect within that minute the core will stop searching for WiFi and proceed to display the data offline, on the OLED.
  • Once the 2 minute counter is up you have approximately a minute to start xZeroTouch configuration
To reconfigure the WiFi with xZeroTouch follow these steps
  • Open the app after you've connect you phone to your preferred WiFi network
  • See the Network under the SSID(WiFi Network Name) heading in the app
  • Enter the WiFi Password(PSK) into the box containing the word password in faded grey
  • Select the minimum of one core on the toggle bar
  • Click the button "Provision" to reconfigure the core WiFi

Blynk

You can configure the Blynk app for use with your Weather Station kit, for more information read Blynk functionality and Build a basic Blynk interface. Below are the Virtual PIN keys for Blynk widgets specifically set for the Weather Station project.

XK01 - Weather Station - Blynk Virtual PINS

☒CHIP Virtual PIN Data Widget Type Unit
CW01 V1 UNIT NAME VALUE DISPLAY N/A
CW01 V2 CLIENT ID VALUE DISPLAY N/A
CW01 V3 MAC ADDRESS VALUE DISPLAY N/A
CW01 V4 INDEX VALUE DISPLAY N/A
CW01 V5 LOCATION MAP N/A
CW01 V6 ALTITUDE (m) VALUE DISPLAY N/A
SL01 V11 AMBIENT LIGHT LABELED VALUE Lux
SL01 V12 UVA LABELED VALUE mW/m2
SL01 V13 UVB LABELED VALUE mW/m2
SL01 V14 UV INDEX VALUE DISPLAY N/A
SG33 V21 tVOC VALUE DISPLAY ppb
SG33 V22 eC02 VALUE DISPLAY ppm
SW01 V31 TEMP C LABELED VALUE °C
SW01 V32 TEMP F LABELED VALUE °F
SW01 V34 ALTITUDE (ft) LABELED VALUE ft
SW01 V33 ALTITUDE (m) LABELED VALUE m
SW01 V35 PRESSURE LABELED VALUE Pa
SW01 V36 HUMIDITY LABELED VALUE  %

Here is an example of what a Blynk interface for the Weather Station kit can look like, using the above mentioned Virtual pins

BlynkWeatherStationExample.PNG

Troubleshooting

Technology