Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 3.03 KB

README.md

File metadata and controls

50 lines (31 loc) · 3.03 KB
Raw

Ambient Arduino Library for Sony Spresense LTE-M

This library is an Arduino library for Spresensen LTE-M board to connect to the Ambient service.

Sony Spresense LTE-M

What is Sony Spresense LTE-M?

Sony Spresense is a single board computer integrated with a positioning functionality that has GPS, GLONASS and QZSS (みちびき) that enables to get a precise position. Sony released Spresense LTE-M extension board having an LTE-M module that is made by Altair of a Sony group company. LTE-M is a super low power communication method (LPWA: Low Power Wide Area) using LTE licensed band. It would be suitable for IoT PoC driven by batteries. For more information, please refer to the Sony support site.

Spresense main and LTE-M

What is Ambient?

"Ambient" is an IoT cloud service in Japan to make IoT data to be visualized. And it is able to put the data on maps easily when you add the position information. Ambient also has a powerful graphing function that is very easy to see your collected data. Using the service is also very easy. Sign in your account with your email, then you can use the basic service free of charge.

Ambient Graph function

Example

The example sketches in this library will give you a hint to make an application of collecting and sending your position using Sony Spresense. This library supports only the sending (write) function.

Sony Spresense with Ambient

This library defines its instance named "theAmbient". It means you can use it directly when "Ambient_SprensenseLTEM.h" is included. The below is the description of the outline of the library.

  • theAmbient.begin("apn_name", "apn_usrname", "apn_passwd")
    apn_name: an APN name given by operators of your SIM card
    apn_usrname: an APN user name given by operators of your SIM card
    apn_passwd: an APN password given by operators of your SIM card

  • theAmbient.setupChannel(channel_id, "writeKey")
    channel_id: a channelId given by Ambient service
    writeKey: a write key given by Ambient service

  • theAmbient.set(field, "data")
    field: specifing a field number to put your data (The field numbers of "9" and "10" are reserved for latitudes and longitudes)
    data: data to put on Ambient

  • theAmbient.send()
    Send data set by theAmbient.set() the Ambient service

  • theAmbinet.clear(field)
    Clear data of a specified field on the channel

  • theAmbinet.clearAll()
    Clear all data on the channel

  • theAmbient.end()
    Close the channel