Seeed SENSECAP User Manual Download Page 51

Page: 51 / 51

User Guide (Tech Document)

API Instruction

SenseCAP API is for users to manage IoT devices and data. It combines three types of API methods:
HTTP protocol, MQTT protocol and Websocket protocol.

⚫

With HTTP API, users can manage LoRa and NB-IoT devices, to get RAW data or historical data.

⚫

With MQTT API, users can subscribe to the sensor's real-time measurement data through the MQTT
protocol.

⚫

With Websocket API, users can get real-time measurement data of sensors through Websocket
protocol.

Please refer to this link for API User Guide:

https://sensecap.gitbook.io/doc/

Summary of Contents for SENSECAP

Page 2: ...Ground Cable 17 3 2 8 Connecting to Power Cable 18 Installing Sensor Node 19 3 3 1 Power On 19 3 3 2 Installing the Sensor Node Bracket 20 3 3 3 Installing Sensor Nodes 21 3 3 4 Dos and Don ts in Installing Sensor Probes 22 4 Network Configuration 24 Gateway Network Configuration 25 4 1 1 Connecting to Ethernet 25 4 1 2 Connecting to 4G 26 Device Status Check Dos Don ts 27 4 2 1 Checking Gateway C...

Page 3: ...heck Account Info 42 5 6 2 Access Key Management 42 6 SenseCAP App Instructions 43 Download SenseCAP App 44 Bind Devices 45 6 2 1 Group Management 46 6 2 2 Check Groups 46 6 2 3 Create New Groups 46 Device Management 48 6 3 1 Check Device 48 6 3 2 Device Details 48 User Profile 50 6 4 1 Check Current Account 50 6 4 2 Settings 50 6 4 3 Sign Out 50 7 API Instruction 51 ...

Page 4: ...ernet and 4G The Sensor Node is powered by a high capacity battery that lasts up to 3 years if uploading data once every hour It also supports hot swap making it easy for maintenance and upgrading SenseCAP provides an easy to use cloud platform Users can scan the QR code with the SenseCAP App to bind the device with its respective account to manage the devices and check Sensor Node data on the Sen...

Page 5: ...g people without engineering background to install the devices quickly Modular design for the Sensor Nodes including a Sensor Node Controller and a Sensor Probe with a specially designed bracket for easy installation on poles or walls LoRaWAN Gateway At the bottom of the gateway are Ethernet port and power connector all of which meet the waterproof requirements LED indicator light indicates the ne...

Page 6: ...nd serial ports which will be used for firmware upgrading The two parts connect and communicate via two spring connectors Each Sensor Node comes with a bracket for easy installation on a pole or wall SenseCAP Portal SenseCAP Portal provides multiple services including web based management portal and API for calling data Users can further develop system integration with the API without worrying abo...

Page 8: ... is connected to Internet successfully 4 Creating Groups and binding devices 1 Register SenseCAP Portal accounts and create Node Groups station 1 station 2 station 3 2 Bind the Gateway and Sensor Node by scanning QR code or manually entering EUI through SenseCAP App and bind the nodes to specific Node Groups 3 Switch ON the Sensor Node turn on the sensor probe turn on the power switch to the ON an...

Page 9: ... rights reserved www seeed cc 9 51 3 Device Installation In this chapter we will introduce the gateway and sensor nodes their respective installation processes as well as the dos and don ts Before installing please check the part list to ensure nothing is missing ...

Page 10: ...ltra long distance communication you will need to purchase a high gain fiberglass antenna Item Name Quantity 1 LoRa Gateway 1 2 LoRa Antenna 1 3 4G Antenna 1 4 Power Adapter 1 5 Power Extension Cable 5M 1 6 Zip Ties 2 7 Mounts 4 8 M5 Self drilling Screw 8 9 Allen Hex Key 1 10 Antenna Lightning Protector Optional 1 11 LoRa Fiberglass Omni Antenna Optional 1 12 LoRa Antenna Brackets Optional 1 ...

Page 11: ...tity 1 Sensor 1 2 Bracket 1 3 M4 Self drilling Screw 4 4 M3 Self drilling Screw 2 3 1 3 Other Accessories Tool List For installing in different scenarios you might need to purchase extra accessories or tools Item Name Quantity 1 GND Copper Wire 2 5mm2 2 2 Pliers 1 3 M4x12 Grounding Screw 1 4 Waterproof Self adhesive Tape to protect antenna connection part 1 5 M6 Self drilling Screw to install the ...

Page 12: ...kage to fasten the 4 brackets onto the gateway And then use cable ties to fasten the gateway onto the pole Recommended pole diameter is 70mm Put cable ties through the holes of the bracket and pull to fasten onto the pole To get better communication range it is recommended to mount the gateway 3 meters above the ground If there are tall buildings around the gateway should be kept away from the bui...

Page 13: ...are screws according to the wall materials recommended screw diameter 6mm 3 2 2 Installation Precautions 1 In mountainous or thunderstorm stricken areas please take lightening protection measures For fiberglass LoRa antenna you will need to install a lightening arrester and make sure it is connected to the ground In addition the gateway should be mounted lower than the lightening rod 2 When instal...

Page 14: ...ww seeed cc 14 51 If the sensor has wires install threaded tubes 3 2 3 Install SIM Card Use the hex key included in the package to unscrew the 6 screws and open the lid Note The tape must be wound clockwise because the antenna is fastened clockwise Otherwise the antenna may loosen ...

Page 15: ...IM card socket Make sure it is installed correctly and close the lid with the screws 3 2 4 Connecting to Ethernet Cable Unscrew to open the protection cap plug the Ethernet cable through the cap and then into the Ethernet port Screw to fasten this part 3 2 5 Installing 4G Antenna Unscrew to remove the copper cap on the 4G antenna port and screw clockwise to install the 4G antenna onto the gateway ...

Page 16: ...ed in the package and the fiberglass LoRa antenna to be purchased separately The installation method for normal LoRa antenna is the same as that of 4G antenna Here we will introduce how to install the fiberglass LoRa antenna 1 Unscrew to remove the copper cap on the LoRa antenna port and fasten the lightening arrester onto the antenna port 2 As shown in the image below please fasten the fiberglass...

Page 17: ...line to connect the lightening arrester with the fiberglass antenna 3 2 7 Installing Ground Cable Here we will connect the lightening arrester to the GND screw port on the gateway with a ground cable and then connect the whole device to the ground The image below shows the location of the GND port at the backside of the gateway ...

Page 18: ...ws and then connect the two copper cables to the GND screw port Use screw to connect and fasten them 3 Once the two cables are connected connect the other end of the long cable to the ground Depending on your actual installation environment you can connect it to the ground directly or connect it to the copper ground bars 3 2 8 Connecting to Power Cable Unscrew to take off the power cap plug in the...

Page 19: ...or as an example and applies to all other SenseCAP sensors 2 After opening the device turn the switch to ON and the LED on the lower right corner will flash indicating that the power is on Wait for about 10 seconds then the LED will flash quickly for 2 seconds indicating that the device is connected to the network 3 After the device is connected to the network connect the Sensor Probe back with th...

Page 20: ...for installing SenseCAP Sensor Nodes the bracket consist of a bracket and a sliding cap With designated screw holes the bracket helps fasten the Sensor Node firmly onto a pole or a wall 1 To install on a pole you can use zip ties to fasten the bracket recommended pole dimension is 50 70mm in diameter Please refer to the following image for bracket directions ...

Page 21: ...rd with the label facing outward Be consistent with the bracket gap Make sure the circle part in the middle of Sensor Node is aligned with the middle of the bracket and then press the Sensor Node to fit into the bracket A click snap sound indicates that the Sensor Node has been installed successfully Try to manually twist it to make sure the Sensor Node is locked to the bracket securely 2 Secure b...

Page 22: ... onto the bracket securely 3 3 4 Dos and Don ts in Installing Sensor Probes The same instruction applies for installing the different Sensor Nodes However there are some tips to keep in mind when installing certain Sensor Nodes Light Sensor The Sensor Probe of the Light Sensor needs to be placed vertically upward and there should not be anything obstructing sunlight from the Sensor Probe ...

Page 23: ...cc 23 51 CO2 Sensor The Sensor Probe can be fastened with self drilling screws Please refer to the image below for probe direction The end without the cables should point downward to prevent rain or dust from getting into the probe Also the device should be in a place with good ventilation ...

Page 24: ...Ltd All rights reserved www seeed cc 24 51 4 Network Configuration After installing the device you need to test and configure the network If the device is to be installed in a high place you can also test and set up the network connection before installing ...

Page 25: ...ote the device should be POWERED OFF when installing the antenna or the antenna circuits might be damaged 4 1 1 Connecting to Ethernet Please refer to previous chapter to connect the gateway to the Ethernet cable and power cable Power on the gateway and wait for 1 2 minutes When the light is on it indicates that the gateway is connected to the network successfully Please see below for different in...

Page 26: ...nly supports 4G network Then connect the gateway to the Ethernet cable and power cable Power on the gateway The process and LED indications are the same as connecting to Ethernet as shown above Note Select a way to access the Internet If cable network is selected please take out 4G card If you choose 4G network do not connect to Ethernet Because when the network is unstable it may cause conflicts ...

Page 27: ...y is connected and in working condition flashing means network latency or no connection When the connection resumes the indicator will be ON App In the SenseCAP App Online status indicates Online when the gateway is connected to the network and can receive and transfer sensor data Please refer to Chapter 6 for obtaining the SenseCAP App 4 2 2 Sensor Node Working Status You can refer to the LED ind...

Page 28: ...ap seeed cc We will deal with it in time 4 2 3 Booting and Rebooting Sensor Nodes To reboot the device we d suggest you use the RESET button instead of flipping the power switch When using the power switch to reboot the device please turn off the device and wait 3 seconds before turning it back on When the device is working in ultra low power consumption mode it can keep working for a while after ...

Page 29: ...cess is abnormal and the sensor needs to be restarted to enter the network again Greater than 0 means normal Online Status online or offline Note After joining the network the Sensor Count must be greater than 0 otherwise the node cannot use functions such as data charts If it is 0 use the RESET button of the node to re enter the network and return to normal ...

Page 30: ...anage SenseCAP devices and to store data It is built on Azure the secure and reliable cloud service from Microsoft You can apply for an account and bind all devices to this account SenseCAP provides the web portal and API The web portal includes Dashboard Device Management Data Management and Access Key Management while API is open to users for further development ...

Page 31: ...EUI is unique Device Code Information encoding for device binding network access etc Term Explanation EUI The unique identifier for each SenseCAP device Access Key The key for accessing API Cloud Service The general term that includes a series of services cloud platform API and App etc Dashboard The interface that monitors and displays data SenseCAP App The iOS Android tool that binds the devices ...

Page 33: ...istered email will be sent to the user s mailbox Open the SenseCAP Email click the jump link fill in the relevant information and complete the registration Return to the login interface and complete the login Note If you can t find the email it may be automatically identified as spam and put in the trash can Password Retrieval If you forget your password when logging in you can retrieve it through...

Page 34: ...portal version upgrade and other information Scene the corresponding visual display module is configured according to the sensor area Chart one or more sensors of the same type can be selected to display historical data over a period of time 5 3 1 Configure Scene According to the installation site or application scenario you can choose to create scene data by grouping different data and show the l...

Page 35: ...5 51 Customize the name create the scene display of station 1 and select Add measurement type Select the measurement data to be displayed under the group of station 1 and confirm 5 3 2 Configure Charts You can create charts to show the info such as measurement type device EUI and time range etc ...

Page 36: ... 51 Select Add Chart Customize the name and select add measure type Select the data type and time period to display Select group Select the specific sensor node under the group Select the measurement type Confirm Note Only one measurement type can be added per chart Add up to 5 curves per chart ...

Page 37: ...anagement Node Group Management and Sensor Node Management 5 4 1 Gateway Filter the gateway based on EUI frequency status and registration time List of gateways displaying EUI name status and so on Click EUI to enter the device details page to view basic information location etc 5 4 2 Node Group Management You can manage devices conveniently by groups You can create new groups delete groups or mov...

Page 38: ...devices to a certain group 5 4 3 Sensor Node Management At the page of Sensor Node you can see all the Sensor Nodes bound to your account Devices contain types such as LoRa and NB IoT and can be viewed by category Filter criteria according to EUI frequency group status registration time filter node ...

Page 39: ...ights reserved www seeed cc 39 51 Sensor Node list displaying EUI name status data type and so on Click EUI to enter the device details page and view the basic information of the Sensor Node Click the coordinates of the map to set the positioning of the Sensor Node ...

Page 40: ... types such as LoRa and NB IoT and can be viewed by category Filter criteria according to EUI frequency group status registration time filter node List of data showing EUI device name data type measurements collection and upload time etc Click EUI to enter the device details page and view the basic information of the Sensor Node Graph ...

Page 41: ... a new page enter a page name and select the number of rows and columns Select the measurements and time intervals to be displayed Select specific sensor data Note Up to three rows and three columns can be set per page and multiple pages can be created Please refer to Dashboard chart for detailed steps ...

Page 42: ... 51 Security 5 6 1 Check Account Info In Account Management page you can check your account info and click to change the info 5 6 2 Access Key Management Access Key is used for accessing API And Security Credentials provides functions such as Create Update and Check for you to manage Access Key ...

Page 43: ...ide Tech Document 2008 2019 Seeed Technology Co Ltd All rights reserved www seeed cc 43 51 6 SenseCAP App Instructions As a tool SenseCAP App is used to bind devices to your account and check device basic info ...

Page 44: ...008 2019 Seeed Technology Co Ltd All rights reserved www seeed cc 44 51 Download SenseCAP App For iOS please search for SenseCAP in Apple Store and download For Android you can download the App from https www pgyer com sensecap ...

Page 45: ...e Scan the QR code on the device to bind the device to your account If you do not set it to a designated group the device will be put into the default group Manually fill in the EUI If the QR code sticker is damaged you can manually fill in the EUI of the device to bind the device to your account Please make sure you put in the EUI in the format suggested by the system and then click confirm ...

Page 46: ...reserved www seeed cc 46 51 6 2 1 Group Management 6 2 2 Check Groups Click Group on the upper left corner to check the list of Groups and manage Groups 6 2 3 Create New Groups On the upper right corner click Create to add a new Group fill in the group name click Confirm ...

Page 48: ...ce On SenseCAP App homepage the devices are shown in Groups You can click Unfold to show the devices in respective Groups The info shown here includes device name type and EUI 6 3 2 Device Details Click device name to enter its respective page showing device name type EUI status time of the latest message and 10 recent RAW messages ...

Page 50: ...c 50 51 User Profile 6 4 1 Check Current Account At My Profile page you can check the current account 6 4 2 Settings You can change map service provider based on the actual needs in the local areas where you deploy the solution 6 4 3 Sign Out Click Sign Out to log out of your current account ...

Page 51: ...TTP protocol MQTT protocol and Websocket protocol With HTTP API users can manage LoRa and NB IoT devices to get RAW data or historical data With MQTT API users can subscribe to the sensor s real time measurement data through the MQTT protocol With Websocket API users can get real time measurement data of sensors through Websocket protocol Please refer to this link for API User Guide https sensecap...

Search results

Summary of Contents for SENSECAP

Reviews:

Related manuals for SENSECAP

Brands by name

Popular brands

Seeed SENSECAP, User Manual

Search results

Summary of Contents for SENSECAP

Reviews:

Related manuals for SENSECAP

Brands by name

Popular brands