first commit
144
.gitignore
vendored
Normal file
@ -0,0 +1,144 @@
|
|||||||
|
# Dependencies
|
||||||
|
/node_modules
|
||||||
|
|
||||||
|
# Production
|
||||||
|
/build
|
||||||
|
|
||||||
|
# Generated files
|
||||||
|
.docusaurus
|
||||||
|
.cache-loader
|
||||||
|
|
||||||
|
# Misc
|
||||||
|
.DS_Store
|
||||||
|
.env.local
|
||||||
|
.env.development.local
|
||||||
|
.env.test.local
|
||||||
|
.env.production.local
|
||||||
|
|
||||||
|
# Python
|
||||||
|
*.pyc
|
||||||
|
__pycache__/
|
||||||
|
*.py[cod]
|
||||||
|
*$py.class
|
||||||
|
|
||||||
|
# C extensions
|
||||||
|
*.so
|
||||||
|
|
||||||
|
# Distribution / packaging
|
||||||
|
.Python
|
||||||
|
|
||||||
|
# PyInstaller
|
||||||
|
# Usually these files are written by a python script from a template
|
||||||
|
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
||||||
|
*.manifest
|
||||||
|
*.spec
|
||||||
|
|
||||||
|
# Installer logs
|
||||||
|
pip-log.txt
|
||||||
|
pip-delete-this-directory.txt
|
||||||
|
|
||||||
|
# Unit test / coverage reports
|
||||||
|
htmlcov/
|
||||||
|
.tox/
|
||||||
|
.nox/
|
||||||
|
.coverage
|
||||||
|
.coverage.*
|
||||||
|
.cache
|
||||||
|
nosetests.xml
|
||||||
|
coverage.xml
|
||||||
|
*.cover
|
||||||
|
*.py,cover
|
||||||
|
.hypothesis/
|
||||||
|
.pytest_cache/
|
||||||
|
cover/
|
||||||
|
|
||||||
|
# Translations
|
||||||
|
*.mo
|
||||||
|
*.pot
|
||||||
|
|
||||||
|
# Django stuff:
|
||||||
|
*.log
|
||||||
|
local_settings.py
|
||||||
|
db.sqlite3
|
||||||
|
db.sqlite3-journal
|
||||||
|
|
||||||
|
# Flask stuff:
|
||||||
|
instance/
|
||||||
|
.webassets-cache
|
||||||
|
|
||||||
|
# Scrapy stuff:
|
||||||
|
.scrapy
|
||||||
|
|
||||||
|
# Sphinx documentation
|
||||||
|
docs/_build/
|
||||||
|
|
||||||
|
# PyBuilder
|
||||||
|
.pybuilder/
|
||||||
|
target/
|
||||||
|
|
||||||
|
# Jupyter Notebook
|
||||||
|
.ipynb_checkpoints
|
||||||
|
|
||||||
|
# IPython
|
||||||
|
profile_default/
|
||||||
|
ipython_config.py
|
||||||
|
.pdm.toml
|
||||||
|
|
||||||
|
__pypackages__/
|
||||||
|
|
||||||
|
# Celery stuff
|
||||||
|
celerybeat-schedule
|
||||||
|
celerybeat.pid
|
||||||
|
|
||||||
|
# SageMath parsed files
|
||||||
|
*.sage.py
|
||||||
|
|
||||||
|
# Environments
|
||||||
|
.env
|
||||||
|
.venv
|
||||||
|
env/
|
||||||
|
venv/
|
||||||
|
ENV/
|
||||||
|
env.bak/
|
||||||
|
venv.bak/
|
||||||
|
|
||||||
|
# Spyder project settings
|
||||||
|
.spyderproject
|
||||||
|
.spyproject
|
||||||
|
|
||||||
|
# Rope project settings
|
||||||
|
.ropeproject
|
||||||
|
|
||||||
|
# mkdocs documentation
|
||||||
|
/site
|
||||||
|
|
||||||
|
# mypy
|
||||||
|
.mypy_cache/
|
||||||
|
.dmypy.json
|
||||||
|
dmypy.json
|
||||||
|
|
||||||
|
# Pyre type checker
|
||||||
|
.pyre/
|
||||||
|
|
||||||
|
# pytype static type analyzer
|
||||||
|
.pytype/
|
||||||
|
|
||||||
|
# Cython debug symbols
|
||||||
|
cython_debug/
|
||||||
|
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
|
||||||
|
yarn.lock
|
||||||
|
|
||||||
|
## vscode
|
||||||
|
|
||||||
|
.vscode/*
|
||||||
|
.*vs*
|
||||||
|
|
||||||
|
# plugin FrontMatter
|
||||||
|
frontmatter.json
|
||||||
|
taxonomyDb.json
|
||||||
|
|
||||||
|
XIAO_ESP32C6_Swift_Matter.md
|
||||||
15
.markdownlint.json
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"default": true,
|
||||||
|
"no-trailing-punctuation": {
|
||||||
|
"punctuation": ".,;:!"
|
||||||
|
},
|
||||||
|
"MD002": { "level": 2 },
|
||||||
|
"MD013": false,
|
||||||
|
"MD024": false,
|
||||||
|
"MD033": false,
|
||||||
|
"first-line-h1": false,
|
||||||
|
"no-hard-tabs": true,
|
||||||
|
"no-trailing-spaces": {
|
||||||
|
"br_spaces": 2
|
||||||
|
}
|
||||||
|
}
|
||||||
83
CONTRIBUTING.md
Normal file
@ -0,0 +1,83 @@
|
|||||||
|
# How to become a contributor and submit your own code
|
||||||
|
|
||||||
|
## Contributor License Agreements
|
||||||
|
|
||||||
|
We'd love to accept your sample apps and patches! Before we can take them, we
|
||||||
|
have to jump a couple of legal hurdles.
|
||||||
|
|
||||||
|
* If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to read
|
||||||
|
[individual CLA](#i_CLACLA) , and send email to us.
|
||||||
|
* If you work for a company that wants to allow you to contribute your work,then you'll need to sign a
|
||||||
|
[corporate CLA](#c_CLA), and send email to us.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Follow either of the two links above to access the appropriate CLA and
|
||||||
|
instructions for how to sign and return it. Once we receive it, we'll be able to
|
||||||
|
accept your pull requests.
|
||||||
|
|
||||||
|
## Contributing A Patch
|
||||||
|
|
||||||
|
1. Submit an issue describing your proposed change to the repository in question.
|
||||||
|
1. The repository owner will respond to your issue promptly.
|
||||||
|
1. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above).
|
||||||
|
1. Fork the desired repository, develop and test your code changes.
|
||||||
|
1. Ensure that your code adheres to the existing style in the sample to which you are contributing.
|
||||||
|
1. Ensure that your code has an appropriate set of unit tests which all pass.
|
||||||
|
1. Submit a pull request!
|
||||||
|
|
||||||
|
## i_CLA
|
||||||
|
|
||||||
|
In order to clarify the intellectual property license granted with Contributions from any person or entity, Seeed Studio must have a Contributor License Agreement ("CLA") on file that has been signed by each Contributor, indicating agreement to the license terms below. This license is for your protection as a Contributor as well as the protection of Seeed Studio; it does not change your rights to use your own Contributions for any other purpose.
|
||||||
|
|
||||||
|
You accept and agree to the following terms and conditions for Your present and future Contributions submitted to Seeed Studio. Except for the license granted herein to Seeed Studio and recipients of software distributed by Seeed Studio, You reserve all right, title, and interest in and to Your Contributions.
|
||||||
|
|
||||||
|
Definitions.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with Seeed Studio. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to Seeed Studio for inclusion in, or documentation of, any of the products owned or managed by Seeed Studio (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to Seeed Studio or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Seeed Studio for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
|
||||||
|
|
||||||
|
Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to Seeed Studio and to recipients of software distributed by Seeed Studio a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
|
||||||
|
|
||||||
|
Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to Seeed Studio and to recipients of software distributed by Seeed Studio a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
|
||||||
|
|
||||||
|
You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to Seeed Studio, or that your employer has executed a separate Corporate CLA with Seeed Studio.
|
||||||
|
|
||||||
|
You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions.
|
||||||
|
|
||||||
|
You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON- INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
|
||||||
|
|
||||||
|
Should You wish to submit work that is not Your original creation, You may submit it to Seeed Studio separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
|
||||||
|
|
||||||
|
You agree to notify Seeed Studio of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect.
|
||||||
|
|
||||||
|
Manage your Agreements
|
||||||
|
|
||||||
|
## c_CLA
|
||||||
|
|
||||||
|
In order to clarify the intellectual property license granted with Contributions from any person or entity, Seeed Studio must have a Contributor License Agreement (CLA) on file that has been signed by each Contributor, indicating agreement to the license terms below. This license is for your protection as a Contributor as well as the protection of Seeed Studio and its users; it does not change your rights to use your own Contributions for any other purpose.
|
||||||
|
|
||||||
|
This version of the Agreement allows an entity (the "Corporation") to submit Contributions to Seeed Studio, to authorize Contributions submitted by its designated employees to Seeed Studio, and to grant copyright and patent licenses thereto.
|
||||||
|
|
||||||
|
You accept and agree to the following terms and conditions for Your present and future Contributions submitted to Seeed Studio. Except for the license granted herein to Seeed Studio and recipients of software distributed by Seeed Studio, You reserve all right, title, and interest in and to Your Contributions.
|
||||||
|
|
||||||
|
Definitions.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is making this Agreement with Seeed Studio. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"Contribution" shall mean the code, documentation or any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to Seeed Studio for inclusion in, or documentation of, any of the products owned or managed by Seeed Studio (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to Seeed Studio or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Seeed Studio for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
|
||||||
|
|
||||||
|
Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to Seeed Studio and to recipients of software distributed by Seeed Studio a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
|
||||||
|
|
||||||
|
Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to Seeed Studio and to recipients of software distributed by Seeed Studio a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that your Contribution, or the Work to which you have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
|
||||||
|
|
||||||
|
You represent that You are legally entitled to grant the above license. You represent further that each employee of the Corporation designated by You is authorized to submit Contributions on behalf of the Corporation.
|
||||||
|
|
||||||
|
You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others).
|
||||||
|
|
||||||
|
You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
|
||||||
|
|
||||||
|
Should You wish to submit work that is not Your original creation, You may submit it to Seeed Studio separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
|
||||||
|
|
||||||
|
It is your responsibility to notify Seeed Studio when any change is required to the list of designated employees authorized to submit Contributions on behalf of the Corporation, or to the Corporation's Point of Contact with Seeed Studio.
|
||||||
1
HOW_TO.md
Normal file
@ -0,0 +1 @@
|
|||||||
|
We offer two different PR ways on the wiki platform. Please check the [Contributor Guide](https://wiki.seeedstudio.com/Contributor/).
|
||||||
674
LICENSE
Normal file
@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
104
README.md
Normal file
@ -0,0 +1,104 @@
|
|||||||
|
# The Seeed Studio Files Management Platform
|
||||||
|
|
||||||
|
[](https://wiki.seeedstudio.com/Getting_Started/)
|
||||||
|
|
||||||
|
Seeed Studio has dedicated to realizing interactive digital replica of our physical world, as being an IoT hardware partner since 2008. This is an open platform collecting all the wikis published by Seeed Studio, to show you the full picture of our efforts, natural environments digitization and outcome production.
|
||||||
|
|
||||||
|
This is the Github source files for Seeed Studio.
|
||||||
|
|
||||||
|
## What does this Wiki Platform Cover?
|
||||||
|
|
||||||
|
This platform will focus on four main topics as shown in the sidebar, with up-to-date information on all of our products.
|
||||||
|
|
||||||
|
- [Sensors and Sensing](https://wiki.seeedstudio.com/Sensor_Network/)
|
||||||
|
- [Networking](https://wiki.seeedstudio.com/Network/)
|
||||||
|
- [Edge Computing](https://wiki.seeedstudio.com/Edge_Computing/)
|
||||||
|
- [Cloud Services](https://wiki.seeedstudio.com/Cloud/)
|
||||||
|
- [Browser-based AI Solution](https://sensecraft.seeed.cc/ai/#/model)
|
||||||
|
- [Technology Topics](https://wiki.seeedstudio.com/topicintroduction/)
|
||||||
|
- [Contributor Program](https://wiki.seeedstudio.com/Contributor/)
|
||||||
|
- [Weekly Wiki](https://wiki.seeedstudio.com/weekly_wiki/)
|
||||||
|
|
||||||
|
[](https://wiki.seeedstudio.com/Getting_Started/)
|
||||||
|
|
||||||
|
## Quick Links
|
||||||
|
|
||||||
|
Thanks for our [contributors](https://wiki.seeedstudio.com/contributors/), the collection pages are done and here are the quick links:
|
||||||
|
|
||||||
|
### Sensor and Sensing
|
||||||
|
|
||||||
|
- [Grove Ecosystem](https://wiki.seeedstudio.com/Grove_System/)
|
||||||
|
- [SenseCAP Ecosystem](https://wiki.seeedstudio.com/SenseCAP_introduction/)
|
||||||
|
- [XIAO Series](https://wiki.seeedstudio.com/SeeedStudio_XIAO_Series_Introduction/)
|
||||||
|
- [Wio Terminal](https://wiki.seeedstudio.com/Wio_Terminal_Intro/)
|
||||||
|
|
||||||
|
[](https://wiki.seeedstudio.com/SeeedStudio_XIAO_Series_Introduction/)
|
||||||
|
|
||||||
|
### Networking
|
||||||
|
|
||||||
|
- [Meshtastic Network](https://wiki.seeedstudio.com/meshtastic_introduction/)
|
||||||
|
- [SenseCAP Gateway](https://wiki.seeedstudio.com/Network/SenseCAP_Network/SenseCAP_Gateway_Intro/)
|
||||||
|
- [Raspberry Pi Network Solution - reRouter](https://wiki.seeedstudio.com/reRouter_Intro/)
|
||||||
|
- [Rockchip Netowrking Solutions](https://wiki.seeedstudio.com/Rockchip_network_solutions/)
|
||||||
|
|
||||||
|
[](https://wiki.seeedstudio.com/meshtastic_introduction/)
|
||||||
|
|
||||||
|
### Edge Computing
|
||||||
|
|
||||||
|
- [Raspberry Pi-related Devices](https://wiki.seeedstudio.com/raspberry-pi-devices/)
|
||||||
|
- [NVIDIA Jetson®-related Devices](https://wiki.seeedstudio.com/NVIDIA_Jetson/)
|
||||||
|
- [ESP-powered Controller](https://wiki.seeedstudio.com/Edgebox-ESP-100-Arduino/)
|
||||||
|
- [BeagleBone®](https://wiki.seeedstudio.com/BeagleBone/)
|
||||||
|
- [ODYSSEY](https://wiki.seeedstudio.com/ODYSSEY_Intro/)
|
||||||
|
|
||||||
|
[](https://wiki.seeedstudio.com/NVIDIA_Jetson/)
|
||||||
|
|
||||||
|
### Cloud
|
||||||
|
|
||||||
|
- [SenseCAP Dashboard](https://wiki.seeedstudio.com/Cloud_Chain/SenseCAP_Dashboard/Dashboard_Basics/)
|
||||||
|
- [SenseCAP API](https://wiki.seeedstudio.com/Cloud_Chain/SenseCAP_API/SenseCAP_API_Introduction/)
|
||||||
|
- [SenseCraft AI](https://wiki.seeedstudio.com/sensecraft_ai/)
|
||||||
|
|
||||||
|
[](https://wiki.seeedstudio.com/sensecraft_ai/)
|
||||||
|
|
||||||
|
### Technology Topics and Popular Platforms
|
||||||
|
|
||||||
|
- [Home Assistant](https://wiki.seeedstudio.com/home_assistant_topic/)
|
||||||
|
- [TinyML](https://wiki.seeedstudio.com/tinyml_topic/)
|
||||||
|
- [Open Source](https://wiki.seeedstudio.com/open_source_topic/)
|
||||||
|
- [Edge AI](https://wiki.seeedstudio.com/edge_ai_topic/)
|
||||||
|
- [Arduino](https://wiki.seeedstudio.com/Arduino/)
|
||||||
|
- [Raspberry Pi](https://wiki.seeedstudio.com/Raspberry_Pi/)
|
||||||
|
- [Micro:bit](https://wiki.seeedstudio.com/microbit_wiki_page/)
|
||||||
|
|
||||||
|
[](https://wiki.seeedstudio.com/home_assistant_topic/)
|
||||||
|
|
||||||
|
## Contributions
|
||||||
|
|
||||||
|
In Seeed, we greatly value our community of Seeeders. The [Seeed Studio Contributor Program](https://wiki.seeedstudio.com/Contributor/) is a collaborative program launched to unite our dear friends from all over the world and co-build innovative solutions together.
|
||||||
|
|
||||||
|
- [Pull Request Guide](https://wiki.seeedstudio.com/Contribution-Guide/)
|
||||||
|
- [Full steps to PR](https://wiki.seeedstudio.com/full_steps_pull_request/) - Able to [see the changes locally](https://wiki.seeedstudio.com/Deploy_Page_Locally)
|
||||||
|
- [Quick steps to PR](https://wiki.seeedstudio.com/quick_pull_request/) - Direct upload with md files and images.
|
||||||
|
|
||||||
|
[](https://wiki.seeedstudio.com/Contributor/)
|
||||||
|
|
||||||
|
### More about Collaborative Programs
|
||||||
|
|
||||||
|
- [The Ranger Program](https://wiki.seeedstudio.com/ranger/)
|
||||||
|
- [The Contributor Program](https://wiki.seeedstudio.com/contributors/)
|
||||||
|
- [Apply for Rangers](https://docs.google.com/forms/d/e/1FAIpQLSdiAWHmRJqgVNTJyJDkzhufc1dygFyhWFyEtUTm-mrgSKaEgg/viewform)
|
||||||
|
- [Direct to Assignment](https://github.com/orgs/Seeed-Studio/projects/6)
|
||||||
|
- [More information to Rangers](https://www.seeedstudio.com/blog/2023/09/15/join-the-seeed-ranger-program-empowering-developers-and-building-communities/)
|
||||||
|
- [More information to Contributors](https://wiki.seeedstudio.com/Contributor/)
|
||||||
|
|
||||||
|
[](https://github.com/orgs/Seeed-Studio/projects/6)
|
||||||
|
|
||||||
|
## Tech Support & Product Discussion
|
||||||
|
|
||||||
|
Thank you for choosing our products! We provide many forms of support to ensure that your experience with our products is as smooth as possible. We offer several communication channels to cater to different preferences and needs.
|
||||||
|
|
||||||
|
- [Forum](https://forum.seeedstudio.com/) - Ideas Exchange
|
||||||
|
- [Email](https://www.seeedstudio.com/contacts) - Expert Supports
|
||||||
|
- [Discord](https://discord.com/invite/eWkprNDMU7) - Collective Chatting
|
||||||
|
- [GitHub Discussion](https://github.com/Seeed-Studio/wiki-documents/discussions/69) - Wiki Suggestions
|
||||||
21
SECURITY.md
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
# Security Policy
|
||||||
|
|
||||||
|
## Supported Versions
|
||||||
|
|
||||||
|
Use this section to tell people about which versions of your project are
|
||||||
|
currently being supported with security updates.
|
||||||
|
|
||||||
|
| Version | Supported |
|
||||||
|
| ------- | ------------------ |
|
||||||
|
| 5.1.x | :white_check_mark: |
|
||||||
|
| 5.0.x | :x: |
|
||||||
|
| 4.0.x | :white_check_mark: |
|
||||||
|
| < 4.0 | :x: |
|
||||||
|
|
||||||
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
|
Use this section to tell people how to report a vulnerability.
|
||||||
|
|
||||||
|
Tell them where to go, how often they can expect to get an update on a
|
||||||
|
reported vulnerability, what to expect if the vulnerability is accepted or
|
||||||
|
declined, etc.
|
||||||
BIN
assets/NVIDIA_Jetson_Hardware_Seeed/nvidia_icon.png
Normal file
|
After Width: | Height: | Size: 20 KiB |
BIN
assets/S.png
Normal file
|
After Width: | Height: | Size: 8.1 KiB |
BIN
assets/docusaurus.png
Normal file
|
After Width: | Height: | Size: 5.0 KiB |
BIN
assets/index/arduino.png
Normal file
|
After Width: | Height: | Size: 1.9 KiB |
BIN
assets/index/arduino_light.png
Normal file
|
After Width: | Height: | Size: 1.9 KiB |
BIN
assets/index/awaken.png
Normal file
|
After Width: | Height: | Size: 950 B |
BIN
assets/index/awaken_light.png
Normal file
|
After Width: | Height: | Size: 953 B |
BIN
assets/index/browse/arduino.png
Normal file
|
After Width: | Height: | Size: 4.7 KiB |
BIN
assets/index/browse/arduino_light.png
Normal file
|
After Width: | Height: | Size: 4.8 KiB |
BIN
assets/index/browse/edgeAi.png
Normal file
|
After Width: | Height: | Size: 3.7 KiB |
BIN
assets/index/browse/edgeAi_light.png
Normal file
|
After Width: | Height: | Size: 4.6 KiB |
BIN
assets/index/browse/ha.png
Normal file
|
After Width: | Height: | Size: 3.1 KiB |
BIN
assets/index/browse/ha_light.png
Normal file
|
After Width: | Height: | Size: 4.0 KiB |
BIN
assets/index/browse/nvidia.png
Normal file
|
After Width: | Height: | Size: 3.1 KiB |
BIN
assets/index/browse/nvidia_light.png
Normal file
|
After Width: | Height: | Size: 4.0 KiB |
BIN
assets/index/browse/raspberry.png
Normal file
|
After Width: | Height: | Size: 4.3 KiB |
BIN
assets/index/browse/raspberry_light.png
Normal file
|
After Width: | Height: | Size: 4.6 KiB |
BIN
assets/index/catalog.png
Normal file
|
After Width: | Height: | Size: 271 B |
BIN
assets/index/cgatbot.png
Normal file
|
After Width: | Height: | Size: 373 B |
BIN
assets/index/contact.png
Normal file
|
After Width: | Height: | Size: 446 B |
BIN
assets/index/dark.png
Normal file
|
After Width: | Height: | Size: 541 B |
BIN
assets/index/edgeai.png
Normal file
|
After Width: | Height: | Size: 2.8 KiB |
BIN
assets/index/edgeai_light.png
Normal file
|
After Width: | Height: | Size: 3.1 KiB |
BIN
assets/index/formSelect.png
Normal file
|
After Width: | Height: | Size: 598 B |
BIN
assets/index/grove.png
Normal file
|
After Width: | Height: | Size: 1.5 KiB |
BIN
assets/index/grove_light.png
Normal file
|
After Width: | Height: | Size: 1.5 KiB |
BIN
assets/index/language.png
Normal file
|
After Width: | Height: | Size: 1.6 KiB |
BIN
assets/index/language_light.png
Normal file
|
After Width: | Height: | Size: 1.4 KiB |
BIN
assets/index/mcu_board.png
Normal file
|
After Width: | Height: | Size: 3.3 KiB |
BIN
assets/index/mcu_board_light.png
Normal file
|
After Width: | Height: | Size: 2.1 KiB |
BIN
assets/index/micro.png
Normal file
|
After Width: | Height: | Size: 1.2 KiB |
BIN
assets/index/micro_light.png
Normal file
|
After Width: | Height: | Size: 1.2 KiB |
BIN
assets/index/opensource.png
Normal file
|
After Width: | Height: | Size: 1.9 KiB |
BIN
assets/index/opensource_light.png
Normal file
|
After Width: | Height: | Size: 2.3 KiB |
BIN
assets/index/platform.png
Normal file
|
After Width: | Height: | Size: 29 KiB |
BIN
assets/index/platform_AI.png
Normal file
|
After Width: | Height: | Size: 81 KiB |
BIN
assets/index/platform_AI1.png
Normal file
|
After Width: | Height: | Size: 100 KiB |
BIN
assets/index/platform_assistant.png
Normal file
|
After Width: | Height: | Size: 77 KiB |
BIN
assets/index/platform_edge.png
Normal file
|
After Width: | Height: | Size: 61 KiB |
BIN
assets/index/platform_sensecraft.png
Normal file
|
After Width: | Height: | Size: 53 KiB |
BIN
assets/index/recomputer.png
Normal file
|
After Width: | Height: | Size: 1.4 KiB |
BIN
assets/index/recomputer_light.png
Normal file
|
After Width: | Height: | Size: 1.4 KiB |
BIN
assets/index/reterminal.png
Normal file
|
After Width: | Height: | Size: 2.4 KiB |
BIN
assets/index/reterminal_light.png
Normal file
|
After Width: | Height: | Size: 2.4 KiB |
BIN
assets/index/sbc_board.png
Normal file
|
After Width: | Height: | Size: 2.2 KiB |
BIN
assets/index/sbc_board_light.png
Normal file
|
After Width: | Height: | Size: 1.7 KiB |
BIN
assets/index/sencecap_light.png
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
assets/index/sensecap.png
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
assets/index/sensecap_light.png
Normal file
|
After Width: | Height: | Size: 1.1 KiB |
BIN
assets/index/shopcar.png
Normal file
|
After Width: | Height: | Size: 353 B |
BIN
assets/index/sscma.png
Normal file
|
After Width: | Height: | Size: 70 KiB |
BIN
assets/index/tinyml.png
Normal file
|
After Width: | Height: | Size: 2.4 KiB |
BIN
assets/index/tinyml_light.png
Normal file
|
After Width: | Height: | Size: 2.9 KiB |
BIN
assets/index/workshop.png
Normal file
|
After Width: | Height: | Size: 1.6 KiB |
BIN
assets/index/workshop_light.png
Normal file
|
After Width: | Height: | Size: 1.9 KiB |
BIN
assets/knowledgebase/Wiki_Platform_GT_Logo.jpg
Normal file
|
After Width: | Height: | Size: 250 KiB |
BIN
assets/knowledgebase/knowledge_base1.png
Normal file
|
After Width: | Height: | Size: 40 KiB |
BIN
assets/knowledgebase/knowledge_base2.png
Normal file
|
After Width: | Height: | Size: 74 KiB |
BIN
assets/knowledgebase/knowledge_base3.png
Normal file
|
After Width: | Height: | Size: 50 KiB |
BIN
assets/knowledgebase/knowledge_base4.png
Normal file
|
After Width: | Height: | Size: 54 KiB |
BIN
assets/knowledgebase/knowledge_base5.png
Normal file
|
After Width: | Height: | Size: 41 KiB |
BIN
assets/knowledgebase/knowledge_base6.png
Normal file
|
After Width: | Height: | Size: 14 KiB |
BIN
assets/knowledgebase/tech_support1.png
Normal file
|
After Width: | Height: | Size: 312 KiB |
BIN
assets/knowledgebase/tech_support2.png
Normal file
|
After Width: | Height: | Size: 309 KiB |
BIN
assets/knowledgebase/tech_support3.png
Normal file
|
After Width: | Height: | Size: 325 KiB |
BIN
assets/knowledgebase/tech_support4.png
Normal file
|
After Width: | Height: | Size: 314 KiB |
BIN
assets/right.png
Normal file
|
After Width: | Height: | Size: 866 B |
BIN
assets/texture.png
Normal file
|
After Width: | Height: | Size: 724 B |
3
babel.config.js
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
module.exports = {
|
||||||
|
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
|
||||||
|
};
|
||||||
12
blog/2019-05-28-first-blog-post.md
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
---
|
||||||
|
slug: first-blog-post
|
||||||
|
title: First Blog Post
|
||||||
|
authors:
|
||||||
|
name: Gao Wei
|
||||||
|
title: Docusaurus Core Team
|
||||||
|
url: https://github.com/wgao19
|
||||||
|
image_url: https://github.com/wgao19.png
|
||||||
|
tags: [hola, docusaurus]
|
||||||
|
---
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
44
blog/2019-05-29-long-blog-post.md
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
---
|
||||||
|
slug: long-blog-post
|
||||||
|
title: Long Blog Post
|
||||||
|
authors: endi
|
||||||
|
tags: [hello, docusaurus]
|
||||||
|
---
|
||||||
|
|
||||||
|
This is the summary of a very long blog post,
|
||||||
|
|
||||||
|
Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
|
||||||
|
|
||||||
|
<!--truncate-->
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||||
20
blog/2021-08-01-mdx-blog-post.mdx
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
---
|
||||||
|
slug: mdx-blog-post
|
||||||
|
title: MDX Blog Post
|
||||||
|
authors: [slorber]
|
||||||
|
tags: [docusaurus]
|
||||||
|
---
|
||||||
|
|
||||||
|
Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
|
||||||
|
Use the power of React to create interactive blog posts.
|
||||||
|
|
||||||
|
```js
|
||||||
|
<button onClick={() => alert('button clicked!')}>Click me!</button>
|
||||||
|
```
|
||||||
|
|
||||||
|
<button onClick={() => alert('button clicked!')}>Click me!</button>
|
||||||
|
|
||||||
|
:::
|
||||||
28
blog/2021-08-26-welcome/index.md
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
---
|
||||||
|
slug: welcome
|
||||||
|
title: Welcome
|
||||||
|
authors: [slorber, yangshun]
|
||||||
|
tags: [facebook, hello, docusaurus]
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
|
||||||
|
|
||||||
|
Simply add Markdown files (or folders) to the `blog` directory.
|
||||||
|
|
||||||
|
Regular blog authors can be added to `authors.yml`.
|
||||||
|
|
||||||
|
The blog post date can be extracted from filenames, such as:
|
||||||
|
|
||||||
|
- `2019-05-30-welcome.md`
|
||||||
|
- `2019-05-30-welcome/index.md`
|
||||||
|
|
||||||
|
A blog post folder can be convenient to co-locate blog post images:
|
||||||
|
|
||||||
|
|
||||||
|
The blog supports tags as well!
|
||||||
|
|
||||||
|
**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
17
blog/authors.yml
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
endi:
|
||||||
|
name: Endilie Yacop Sucipto
|
||||||
|
title: Maintainer of Docusaurus
|
||||||
|
url: https://github.com/endiliey
|
||||||
|
image_url: https://github.com/endiliey.png
|
||||||
|
|
||||||
|
yangshun:
|
||||||
|
name: Yangshun Tay
|
||||||
|
title: Front End Engineer @ Facebook
|
||||||
|
url: https://github.com/yangshun
|
||||||
|
image_url: https://github.com/yangshun.png
|
||||||
|
|
||||||
|
slorber:
|
||||||
|
name: Sébastien Lorber
|
||||||
|
title: Docusaurus maintainer
|
||||||
|
url: https://sebastienlorber.com
|
||||||
|
image_url: https://github.com/slorber.png
|
||||||
26
docs/About.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
---
|
||||||
|
name: About Seeeed
|
||||||
|
nointro:
|
||||||
|
authors:
|
||||||
|
name: Gao Wei
|
||||||
|
title: Docusaurus Core Team
|
||||||
|
url: https://github.com/wgao19
|
||||||
|
image_url: https://github.com/wgao19.png
|
||||||
|
---
|
||||||
|
|
||||||
|
[Seeed](https://www.seeedstudio.com) is a hardware innovation platform for makers to grow inspirations into differentiating products. By working closely with technology providers of all scale, Seeed provides accessible technologies with quality, speed and supply chain knowledge. When prototypes are ready to iterate, Seeed helps productize 1 to 1,000 pcs using in-house engineering, supply chain management and agile manufacture forces. Seeed also team up with incubators, Chinese tech ecosystem, investors and distribution channels to portal Maker startups beyond.
|
||||||
|
|
||||||
|
## Tech Support & Product Discussion
|
||||||
|
|
||||||
|
Thank you for choosing our products! We are here to provide you with different support to ensure that your experience with our products is as smooth as possible. We offer several communication channels to cater to different preferences and needs.
|
||||||
|
|
||||||
|
<div class="button_tech_support_container">
|
||||||
|
<a href="https://forum.seeedstudio.com/" class="button_forum"></a>
|
||||||
|
<a href="https://www.seeedstudio.com/contacts" class="button_email"></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="button_tech_support_container">
|
||||||
|
<a href="https://discord.gg/eWkprNDMU7" class="button_discord"></a>
|
||||||
|
<a href="https://github.com/Seeed-Studio/wiki-documents/discussions/69" class="button_discussion"></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
120
docs/Cloud.md
Normal file
@ -0,0 +1,120 @@
|
|||||||
|
---
|
||||||
|
description: Cloud service is a vital component that facilitates processed data management from computing boards and offers real-time operations to users. This page encompasses Seeed's industrial-grade SenseCAP cloud services, as well as other cloud service applications tailored to diverse needs.
|
||||||
|
title: Cloud
|
||||||
|
keywords:
|
||||||
|
- Cloud
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
last_update:
|
||||||
|
date: 05/24/2024
|
||||||
|
author: Matthew
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
Cloud service is a vital component that facilitates processed data management from computing boards and offers real-time operations to users. This page encompasses Seeed's industrial-grade SenseCAP cloud services, as well as other cloud service applications tailored to diverse needs. Through robust cloud infrastructure, Seeed provides users with the ability to securely store, analyze, and leverage processed data, enabling data driven decision-making and enhancing operational efficiency across various domains.
|
||||||
|
|
||||||
|
## SenseCAP Cloud Service
|
||||||
|
|
||||||
|
<strong><font color={'8DC215'} size={"4"}>This section here showcases different cloud services being offered by Seeed Studio, tailed for varying industrial IoT applications. You can explore more on the following areas:</font></strong>
|
||||||
|
|
||||||
|
- Catalogue of SenseCAP Cloud services and ecosystem
|
||||||
|
- Instructions for data management and devices management of each cloud product
|
||||||
|
- APIs for varying connection purposes
|
||||||
|
- Introduction to cloud
|
||||||
|
|
||||||
|
### SenseCAP Dashboard / Portal
|
||||||
|
|
||||||
|
<div class="title_container">
|
||||||
|
<div class="title_item" style={{textAlign: 'center'}}>
|
||||||
|
<div class="start_card_title" style={{textAlign: 'center'}}><font color={'8DC215'} size={"6"}>SenseCAP Protal</font></div>
|
||||||
|
<div class="start_card_title" style={{textAlign: 'center'}}><font color={'FFFFFF'} size={"3"}>This is the SenseCAP Portal for data monitoring of SenseCAP sensors nodes and SenseCAP gateway.</font></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="intro_container">
|
||||||
|
<div class="intro_item" style={{textAlign: 'center'}}>
|
||||||
|
<div class="start_card_title" style={{textAlign: 'center'}}><font color={'8DC215'} size={"5"}>SenseCAP Dashboard</font></div>
|
||||||
|
<a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Dashboard/Dashboard_Basics" target="_blank"><span><font color={'FFFFFF'} size={"2"}> Dashboard Basics </font></span></a>
|
||||||
|
<br/>
|
||||||
|
<a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Dashboard/Dashboard_Registration" target="_blank"><span><font color={'FFFFFF'} size={"2"}> Dashboard Registration </font></span></a>
|
||||||
|
<br/>
|
||||||
|
<a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Dashboard/Hotspot_Registration" target="_blank"><span><font color={'FFFFFF'} size={"2"}> Hotspot Registration </font></span></a>
|
||||||
|
<br/>
|
||||||
|
</div>
|
||||||
|
<div class="intro_item" style={{textAlign: 'center'}}>
|
||||||
|
<div class="start_card_title" style={{textAlign: 'center'}}><font color={'8DC215'} size={"5"}>Data Management</font></div>
|
||||||
|
<a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Portal/Detail_Introduction/Data_Management#table" target="_blank"><span><font color={'FFFFFF'} size={"2"}> Detailed Data showed in Table </font></span></a>
|
||||||
|
<br/>
|
||||||
|
<a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Portal/Detail_Introduction/Data_Management#graph" target="_blank"><span><font color={'FFFFFF'} size={"2"}> Graphical Data showed in Graph </font></span></a>
|
||||||
|
<br/>
|
||||||
|
<a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Portal/Detail_Introduction/Data_Management#check-account-info" target="_blank"><span><font color={'FFFFFF'} size={"2"}> Account Information Checking </font></span></a>
|
||||||
|
<br/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="independent_container">
|
||||||
|
<div class="independent_item" style={{textAlign: 'left'}}>
|
||||||
|
<div class="independent_title" style={{textAlign: 'center'}}><font color={'8DC215'} size={"5"}>Devices Management</font></div>
|
||||||
|
<a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Portal/Detail_Introduction/Device_Management#gateway" target="_blank"><span><font color={'FFFFFF'} size={"2"}> <strong>SenseCAP Gateways</strong> - Displaying EUI, Name, Status, and more info.</font></span></a>
|
||||||
|
<br/>
|
||||||
|
<a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Portal/Detail_Introduction/Device_Management#node-group-management" target="_blank"><span><font color={'FFFFFF'} size={"2"}> <strong>SenseCAP Node Group</strong> - Manage Devices Conveniently by Groups. </font></span></a>
|
||||||
|
<br/>
|
||||||
|
<a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Portal/Detail_Introduction/Device_Management#sensor-node-management" target="_blank"><span><font color={'FFFFFF'} size={"2"}> <strong>SenseCAP Sensor Node</strong> - Displaying EUI, Name, Status, Data Type and more. </font></span></a>
|
||||||
|
<br/>
|
||||||
|
<a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Portal/Detail_Introduction/Device_Management#general-information" target="_blank"><span><font color={'FFFFFF'} size={"2"}> <strong>Devices General Information</strong> - Battery Status, Recent Online Record and more. </font></span></a>
|
||||||
|
<br/>
|
||||||
|
<a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Portal/Detail_Introduction/Device_Management#settings" target="_blank"><span><font color={'FFFFFF'} size={"2"}> <strong>Settings</strong> - Adjust the data collection frequency of the device and more. </font></span></a>
|
||||||
|
<br/>
|
||||||
|
<a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Portal/Detail_Introduction/Device_Management#location" target="_blank"><span><font color={'FFFFFF'} size={"2"}> <strong>Devices Location </strong></font></span></a>
|
||||||
|
/
|
||||||
|
<a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Portal/Detail_Introduction/Device_Management#bind-device" target="_blank"><span><font color={'FFFFFF'} size={"2"}> <strong>Devices Bind </strong></font></span></a>
|
||||||
|
/
|
||||||
|
<a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Portal/Detail_Introduction/Device_Management#channel" target="_blank"><span><font color={'FFFFFF'} size={"2"}> <strong>Devices Channel </strong></font></span></a>
|
||||||
|
/
|
||||||
|
<a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Portal/Detail_Introduction/Device_Management#data" target="_blank"><span><font color={'FFFFFF'} size={"2"}> <strong>Devices Data </strong></font></span></a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
### SenseCAP HotSpot APP
|
||||||
|
|
||||||
|
<div class="title_container">
|
||||||
|
<div class="title_item" style={{textAlign: 'center'}}>
|
||||||
|
<div class="start_card_title" style={{textAlign: 'center'}}><font color={'8DC215'} size={"6"}>SenseCAP HotSpot APP</font></div>
|
||||||
|
This is the SenseCAP HotSpot APP used in mobile phones to manage LoRaWAN hotspot.
|
||||||
|
<br/>
|
||||||
|
> <a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Hotspot_APP/Download_APP" target="_blank"><span><font color={'FFFFFF'} size={"3"}>Download</font></span></a> / <a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Hotspot_APP/Hotspot_Management" target="_blank"><span><font color={'FFFFFF'} size={"3"}>Hotspot Management</font></span></a> / <a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Hotspot_APP/Remote Reboot" target="_blank"><span><font color={'FFFFFF'} size={"3"}>Remote Reboot</font></span></a> / <a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Hotspot_APP/Hotspot_Onboarding" target="_blank"><span><font color={'FFFFFF'} size={"3"}>Hotspot on Dashboard</font></span></a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
### SenseCAP Mate APP
|
||||||
|
|
||||||
|
<div class="title_container">
|
||||||
|
<div class="title_item" style={{textAlign: 'center'}}>
|
||||||
|
<div class="start_card_title" style={{textAlign: 'center'}}><font color={'8DC215'} size={"6"}>SenseCAP Mate APP</font></div>
|
||||||
|
This is the SenseCAP Mate APP used in mobile phones to display data from SenseCAP sensors.
|
||||||
|
<br/>
|
||||||
|
> <a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Mate_APP/SenseCAP_APP#download" target="_blank"><span><font color={'FFFFFF'} size={"3"}>Download</font></span></a> / <a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Mate_APP/SenseCAP_APP#config" target="_blank"><span><font color={'FFFFFF'} size={"3"}>Bind Devices</font></span></a> / <a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Mate_APP/SenseCAP_APP#account" target="_blank"><span><font color={'FFFFFF'} size={"3"}>Account</font></span></a> / <a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_Mate_APP/SenseCAP_APP#user" target="_blank"><span><font color={'FFFFFF'} size={"3"}>User</font></span></a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
### SenseCAP AI
|
||||||
|
|
||||||
|
<div class="title_container">
|
||||||
|
<div class="title_item" style={{textAlign: 'center'}}>
|
||||||
|
<div class="start_card_title" style={{textAlign: 'center'}}><font color={'8DC215'} size={"6"}>SenseCAP AI </font></div>
|
||||||
|
Use SenseCAP AI on SenseCAP Portal and SenseCAP Mate APP.
|
||||||
|
<br/>
|
||||||
|
> <a href="https://wiki.seeedstudio.com/How_to_Use_SenseCAP_AI_on_SenseCAP_Portal_and_SenseCAP_Mate_APP" target="_blank"><span><font color={'FFFFFF'} size={"3"}>Getting Started</font></span></a>
|
||||||
|
> <a href="https://wiki.seeedstudio.com/xiao_esp32c3_sensecapai/" target="_blank"><span><font color={'FFFFFF'} size={"3"}>Using XIAO ESP32C3 to connect</font></span></a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
### SenseCAP API
|
||||||
|
|
||||||
|
<div class="title_container">
|
||||||
|
<div class="title_item" style={{textAlign: 'center'}}>
|
||||||
|
<div class="start_card_title" style={{textAlign: 'center'}}><font color={'8DC215'} size={"6"}>SenseCAP API </font></div>
|
||||||
|
This is the SenseCAP API for devices and data management.
|
||||||
|
<br/>
|
||||||
|
> <a href="https://sensecap-docs.seeed.cc/pdf/sensecap_opanapi_document_en.pdf" target="_blank"><span><font color={'FFFFFF'} size={"3"}>Download PDF</font></span></a> / <a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_API/SenseCAP_API_Introduction" target="_blank"><span><font color={'FFFFFF'} size={"3"}>Introduction</font></span></a> / <a href="https://wiki.seeedstudio.com//Cloud_Chain/SenseCAP_API/API_pricing" target="_blank"><span><font color={'FFFFFF'} size={"3"}>API Pricing</font></span></a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
@ -0,0 +1,136 @@
|
|||||||
|
---
|
||||||
|
description: How to Use SenseCAP AI on SenseCAP Portal and SenseCAP Mate APP
|
||||||
|
title: How to Use SenseCAP AI on SenseCAP Portal and SenseCAP Mate APP
|
||||||
|
keywords:
|
||||||
|
- AI
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
slug: /How_to_Use_SenseCAP_AI_on_SenseCAP_Portal_and_SenseCAP_Mate_APP
|
||||||
|
last_update:
|
||||||
|
date: 6/20/2023
|
||||||
|
author: Lee
|
||||||
|
---
|
||||||
|
|
||||||
|
# How to Use SenseCAP AI on SenseCAP Portal and SenseCAP Mate APP
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
**SenseCAP AI** is the AI-powered solution that helps you make the most of your sensor data and unlock the full potential of your sensor data. By connecting your SenseCAP sensors to the SenseCAP platform, you can easily collect and analyze data on environmental factors such as temperature, humidity, light, and air quality. Meanwhile, our powerful AI algorithms then use this data to provide you with actionable insights and recommendations that can help you optimize your operations, reduce costs, and improve efficiency.
|
||||||
|
|
||||||
|
Whether you're looking to monitor air quality, optimize crop growth, or improve efficiency, SenseCAP AI has the tools you need to succeed. SenseCAP AI is currently released on [SenseCAP Portal](https://sensecap.seeed.cc/portal/#/login) and [SenseCAP Mate App](http://sensecap-mate-download.seeed.cc/), where users can use it at any time. With our easy-to-use platform and App, you can quickly connect your sensors and start receiving valuable insights in just minutes.
|
||||||
|
|
||||||
|
Don't miss out on the benefits of AI-powered sensor data analysis. Try SenseCAP AI today!
|
||||||
|
|
||||||
|
<div align="center"><img width ={1000} src="https://files.seeedstudio.com/wiki/SenseCAP_AI/1.png
|
||||||
|
"/></div>
|
||||||
|
|
||||||
|
## Measurements
|
||||||
|
SenseCAP AI currently analyzes the following measurements and device types, and users can select devices that include the following measurements.
|
||||||
|
|
||||||
|
| Measurement | Device Types |
|
||||||
|
|-------------------------|-----------------------------------------------------|
|
||||||
|
| Air Temperature |[SenseCAP S2103 LoRaWAN® CO2, Temperature, and Humidity Sensor](https://www.seeedstudio.com/SenseCAP-S2103-LoRaWAN-CO2-Temperature-and-Humidity-Sensor-p-5356.html)|
|
||||||
|
| |[SenseCAP S2101 LoRaWAN® Air Temperature and Humidity Sensor](https://www.seeedstudio.com/SenseCAP-S2101-LoRaWAN-Air-Temperature-and-Humidity-Sensor-p-5354.html)|
|
||||||
|
| |[S-H2S-01 Industrial-grade MODBUS RS485 H2S Sensor (H2S, Temperature & Humidity)](https://www.seeedstudio.com/RS485-H2S-Sensor-Connector-p-5114.html)|
|
||||||
|
| |[S-NH3-01 Industrial-grade MODBUS RS485 NH3 Sensor (NH3, Temperature & Humidity)](https://www.seeedstudio.com/RS485-NH3-Sensor-Connector-p-5113.html)|
|
||||||
|
| |[SenseCAP S500 Compact Weather Station](https://www.seeedstudio.com/SenseCAP-S500-5-in-1-Compact-Weather-Station-p-5652.html)|
|
||||||
|
| |SenseCAP S300 Compact Weather Station|
|
||||||
|
| |SenseCAP S400 Compact Weather Station|
|
||||||
|
| |[SenseCAP S700 Compact Weather Station ](https://www.seeedstudio.com/SenseCAP-S700-7-in-1-Compact-Weather-Station-p-5651.html)|
|
||||||
|
| |[SenseCAP S900 Compact Weather Station](https://www.seeedstudio.com/SenseCAPONE-S900-9in1-Compact-Weather-Sensor-p-4881.html)|
|
||||||
|
| |[SenseCAP S2120 LoRaWAN 8-in-1 Compact Weather Station ](https://www.seeedstudio.com/sensecap-s2120-lorawan-8-in-1-weather-sensor-p-5436.html)|
|
||||||
|
| |[SenseCAP S800 Compact Weather Station](https://www.seeedstudio.com/SenseCAP-S800-8-in-1-Compact-Weather-Station-p-5653.html)|
|
||||||
|
| |[SenseCAP S1000 Compact Weather Station 10 in 1](https://www.seeedstudio.com/SenseCAP-S1000-10-in-1-Compact-Weather-Station-p-5654.html)|
|
||||||
|
| Air Humidity |Device type is the same as Air Temperature |
|
||||||
|
| Light Intensity |[SenseCAP S2102 LoRaWAN Light Intensity Sensor](https://www.seeedstudio.com/SenseCAP-S2102-LoRaWAN-Light-Intensity-Sensor-p-5355.html)|
|
||||||
|
| |SenseCAP S400 Compact Weather Station |
|
||||||
|
| |[SenseCAP S700 Compact Weather Station](https://www.seeedstudio.com/SenseCAP-S700-7-in-1-Compact-Weather-Station-p-5651.html)|
|
||||||
|
| |[SenseCAP S900 Compact Weather Station](https://www.seeedstudio.com/SenseCAPONE-S900-9in1-Compact-Weather-Sensor-p-4881.html)|
|
||||||
|
| |[SenseCAP S2120 LoRaWAN 8-in-1 Compact Weather Station ](https://www.seeedstudio.com/sensecap-s2120-lorawan-8-in-1-weather-sensor-p-5436.html)|
|
||||||
|
| |[SenseCAP S1000 Compact Weather Station 10 in 1](https://www.seeedstudio.com/SenseCAP-S1000-10-in-1-Compact-Weather-Station-p-5654.html)|
|
||||||
|
| CO2 | CO2 Sensor |
|
||||||
|
| |[SenseCAP S2103 LoRaWAN® CO2, Temperature, and Humidity Sensor](https://www.seeedstudio.com/SenseCAP-S2103-LoRaWAN-CO2-Temperature-and-Humidity-Sensor-p-5356.html)|
|
||||||
|
| |[SenseCAP S1000 Compact Weather Station 10 in 1](https://www.seeedstudio.com/SenseCAP-S1000-10-in-1-Compact-Weather-Station-p-5654.html)|
|
||||||
|
| Soil Temperature | Soil Moisture and Temperature Sensor |
|
||||||
|
| |[SenseCAP Wireless Soil Temperature, VWC & EC Sensor](https://www.seeedstudio.com/SenseCAP-Wireless-Soil-Temperature-VWC-EC-Sensor-LoRaWAN-AS923-MT20-p-4996.html)|
|
||||||
|
| | Soil Temperature and VWC Sensor |
|
||||||
|
| |[SenseCAP S2105 LoRaWAN® Soil Moisture, Temperature and EC Sensor](https://www.seeedstudio.com/SenseCAP-S2105-LoRaWAN-Soil-Temperature-Moisture-and-EC-Sensor-p-5358.html)|
|
||||||
|
| Soil Moisture |Device type is the same as Soil Temperature |
|
||||||
|
| Electrical Conductivity |[SenseCAP Wireless Soil Temperature, VWC & EC Sensor](https://www.seeedstudio.com/SenseCAP-Wireless-Soil-Temperature-VWC-EC-Sensor-LoRaWAN-AS923-MT20-p-4996.html)|
|
||||||
|
| |[SenseCAP S2105 LoRaWAN® Soil Moisture, Temperature and EC Sensor](https://www.seeedstudio.com/SenseCAP-S2105-LoRaWAN-Soil-Temperature-Moisture-and-EC-Sensor-p-5358.html)|
|
||||||
|
| NH3 |[S-NH3-01 Industrial-grade MODBUS RS485 NH3 Sensor (NH3, Temperature & Humidity)](https://www.seeedstudio.com/RS485-NH3-Sensor-Connector-p-5113.html)|
|
||||||
|
| H2S |[S-H2S-01 Industrial-grade MODBUS RS485 H2S Sensor (H2S, Temperature & Humidity)](https://www.seeedstudio.com/RS485-H2S-Sensor-Connector-p-5114.html)|
|
||||||
|
| Photosynthetically Active Radiation (PAR) |[Industrial PAR Sensor S-PAR](https://www.seeedstudio.com/RS485-S-PAR-02B-p-4830.html)|
|
||||||
|
|
||||||
|
|
||||||
|
## SenseCAP Mate App
|
||||||
|
1 Download and login [SenseCAP Mate App](https://app.sensecapmx.com/)
|
||||||
|
|
||||||
|
2 Visit Device page and click **+** icon to bind your SenseCAP sensor by scaning the device QR code
|
||||||
|
|
||||||
|
3 Make sure your sensor sends data to the SenseCAP platform, the SenseCAP AI service needs to use the sensor's data
|
||||||
|
|
||||||
|
4 On Device page click SenseCAP AI to start AI-powered sensor data analysis
|
||||||
|
|
||||||
|
<div align="center"><img width ={1000} src="https://files.seeedstudio.com/wiki/SenseCAP_AI/2.png
|
||||||
|
"/></div>
|
||||||
|
|
||||||
|
5 Enter the crop or animal you are raising and the location
|
||||||
|
|
||||||
|
6 Select the sensor data time
|
||||||
|
|
||||||
|
- Month: sensor data in the last month
|
||||||
|
- 6 Months: sensor data in the last 6 months
|
||||||
|
- Year: sensor data in the last year
|
||||||
|
|
||||||
|
7 Select measurement(up to 5 ): click **+** icon
|
||||||
|
|
||||||
|
- Select device and then select measurement
|
||||||
|
|
||||||
|
<div align="center"><img width ={1000} src="https://files.seeedstudio.com/wiki/SenseCAP_AI/3.png
|
||||||
|
"/></div>
|
||||||
|
|
||||||
|
8 Send the info to SenseCAP AI and then SenseCAP AI will response suggestions
|
||||||
|
|
||||||
|
Note:AI answers are provided for reference only. Please use them with caution as SenseCAP cannot be held responsible for any consequences resulting from the use of AI services.
|
||||||
|
|
||||||
|
<div align="center"><img width ={800} src="https://files.seeedstudio.com/wiki/SenseCAP_AI/4.png
|
||||||
|
"/></div>
|
||||||
|
|
||||||
|
## SenseCAP Portal
|
||||||
|
|
||||||
|
1 Login [SenseCAP Portal(Global)](https://sensecap.seeed.cc/portal/#/login)
|
||||||
|
|
||||||
|
[SenseCAP Portal(China)](http://sensecap.seeed.cn/portal/#/login)
|
||||||
|
|
||||||
|
2 Bind your SenseCAP sensor by inputing sensor's SN and code
|
||||||
|
|
||||||
|
<div align="center"><img width ={1000} src="https://files.seeedstudio.com/wiki/SenseCAP_AI/5.png
|
||||||
|
"/></div>
|
||||||
|
|
||||||
|
3 Make sure your sensor sends data to the SenseCAP platform, the SenseCAP AI service needs to use the sensor's data
|
||||||
|
|
||||||
|
4 Visit SenseCAP AI to start AI-powered sensor data analysis
|
||||||
|
|
||||||
|
5 Enter the crop or animal you are raising and the location
|
||||||
|
|
||||||
|
6 Select the sensor data time
|
||||||
|
|
||||||
|
- Month: sensor data in the last month
|
||||||
|
- 6 Months: sensor data in the last 6 months
|
||||||
|
- Year: sensor data in the last year
|
||||||
|
|
||||||
|
7 Select measurement(up to 5 ): click **+** icon
|
||||||
|
|
||||||
|
- Select device and then select measurement
|
||||||
|
|
||||||
|
<div align="center"><img width ={1000} src="https://files.seeedstudio.com/wiki/SenseCAP_AI/6.png
|
||||||
|
"/></div>
|
||||||
|
|
||||||
|
8 Send the info to SenseCAP AI and then SenseCAP AI will response suggestions
|
||||||
|
|
||||||
|
Note:AI answers are provided for reference only. Please use them with caution as SenseCAP cannot be held responsible for any consequences resulting from the use of AI services.
|
||||||
|
|
||||||
|
<div align="center"><img width ={1000} src="https://files.seeedstudio.com/wiki/SenseCAP_AI/7.png
|
||||||
|
"/></div>
|
||||||
|
|
||||||
|
|
||||||
944
docs/Cloud_Chain/SenseCAP_AI/xiao-esp32c3-sensecapai.md
Normal file
@ -0,0 +1,944 @@
|
|||||||
|
---
|
||||||
|
description: Using XIAO ESP32C3 to connect to SenseCAP AI for planting advice
|
||||||
|
title: Using XIAO ESP32C3 to connect to SenseCAP AI for planting advice
|
||||||
|
keywords:
|
||||||
|
- xiao
|
||||||
|
- sensecap ai
|
||||||
|
- AI
|
||||||
|
image: https://files.seeedstudio.com/wiki/seeed_logo/logo_2023.png
|
||||||
|
slug: /xiao_esp32c3_sensecapai
|
||||||
|
last_update:
|
||||||
|
date: 08/04/2023
|
||||||
|
author: Citric
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
# Using XIAO ESP32C3 to connect to SenseCAP AI for planting advice
|
||||||
|
|
||||||
|
|
||||||
|
<div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/xiao-connect-sensecap/1.png" style={{width:1000, height:'auto'}}/></div>
|
||||||
|
|
||||||
|
|
||||||
|
During this time, Seeed Studio's SenseCAP platform developed and released new AI features. Currently the main features of SenseCAP AI are focused on providing constructive planting advice to growers, and will be updated with richer AI features in the near future!
|
||||||
|
|
||||||
|
This tutorial, then, will bridge the XIAO ESP32 series with the SenseCAP platform, detailing how to use the XIAO and Grove series sensors to upload data to SenseCAP and get constructive suggestions from the AI based on these sensor values.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
### Hardware Preparation
|
||||||
|
|
||||||
|
The three pieces of hardware that will be used in this tutorial are the XIAO ESP32C3, the Grove Base for XIAO, and the Grove SHT40 temperature and humidity sensor. For the convenience of wiring, we use the XIAO expansion board, which you can purchase according to your actual needs.
|
||||||
|
|
||||||
|
<div class="table-center">
|
||||||
|
<table align="center">
|
||||||
|
<tr>
|
||||||
|
<th>Seeed Studio XIAO ESP32C3</th>
|
||||||
|
<th>Grove Base for XIAO</th>
|
||||||
|
<th>Grove - Temperature & Humidity Sensor(SHT40)</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/XIAO_WiFi/board-pic.png" style={{width:100, height:'auto'}}/></div></td>
|
||||||
|
<td><div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/Grove-Shield-for-Seeeduino-XIAO/img/xiao_-Preview-25.png" style={{width:230, height:'auto'}}/></div></td>
|
||||||
|
<td><div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/Wio-Terminal-Developer-for-helium/SHT40.jpg" style={{width:200, height:'auto'}}/></div></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><div class="get_one_now_container" style={{textAlign: 'center'}}>
|
||||||
|
<a class="get_one_now_item" href="https://www.seeedstudio.com/Seeed-XIAO-ESP32C3-p-5431.html">
|
||||||
|
<strong><span><font color={'FFFFFF'} size={"4"}> Get One Now 🖱️</font></span></strong>
|
||||||
|
</a>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="get_one_now_container" style={{textAlign: 'center'}}>
|
||||||
|
<a class="get_one_now_item" href="https://www.seeedstudio.com/Grove-Shield-for-Seeeduino-XIAO-p-4621.html">
|
||||||
|
<strong><span><font color={'FFFFFF'} size={"4"}> Get One Now 🖱️</font></span></strong>
|
||||||
|
</a>
|
||||||
|
</div></td>
|
||||||
|
<td><div class="get_one_now_container" style={{textAlign: 'center'}}>
|
||||||
|
<a class="get_one_now_item" href="https://www.seeedstudio.com/Grove-Temp-Humi-Sensor-SHT40-p-5384.html">
|
||||||
|
<strong><span><font color={'FFFFFF'} size={"4"}> Get One Now 🖱️</font></span></strong>
|
||||||
|
</a>
|
||||||
|
</div></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
### Software Preparation
|
||||||
|
|
||||||
|
If this is your first time using the XIAO ESP32C3, then you can need to read this Wiki first to learn to configure a good development environment in Arduino.
|
||||||
|
|
||||||
|
- [Getting Started with Seeed Studio XIAO ESP32C3](https://wiki.seeedstudio.com/XIAO_ESP32C3_Getting_Started/#software-setup)
|
||||||
|
|
||||||
|
Also, this tutorial is compatible with [XIAO ESP32S3](https://www.seeedstudio.com/XIAO-ESP32S3-p-5627.html), you can also use XIAO ESP32S3 to complete the content of this tutorial.
|
||||||
|
|
||||||
|
- [Getting Started with Seeed Studio XIAO ESP32S3](https://wiki.seeedstudio.com/xiao_esp32s3_getting_started/#software-preparation)
|
||||||
|
|
||||||
|
Since the SHT40 sensor is used, you also need to add the following two libraries well in Arduino to ensure that the program can run smoothly.
|
||||||
|
|
||||||
|
- [arduino-i2c-sht4x](https://github.com/Sensirion/arduino-i2c-sht4x)
|
||||||
|
|
||||||
|
- [Sensirion Arduino Core Library](https://github.com/Sensirion/arduino-core)
|
||||||
|
|
||||||
|
## XIAO ESP32C3 Getting Temperature and Humidity Data
|
||||||
|
|
||||||
|
As shown in the figure below, please connect the Grove SHT40 temperature and humidity sensor to the IIC interface of the XIAO.
|
||||||
|
|
||||||
|
<div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/xiao-connect-sensecap/2.jpg" style={{width:700, height:'auto'}}/></div>
|
||||||
|
|
||||||
|
Then upload the following program for the XIAO ESP32C3 to drive the SHT40 sensor to work and start getting the temperature and humidity values in the air.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
#include <Arduino.h>
|
||||||
|
#include <SensirionI2CSht4x.h>
|
||||||
|
#include <Wire.h>
|
||||||
|
|
||||||
|
SensirionI2CSht4x sht4x;
|
||||||
|
|
||||||
|
void setup() {
|
||||||
|
|
||||||
|
Serial.begin(115200);
|
||||||
|
while (!Serial) {
|
||||||
|
delay(100);
|
||||||
|
}
|
||||||
|
|
||||||
|
Wire.begin();
|
||||||
|
|
||||||
|
uint16_t error;
|
||||||
|
char errorMessage[256];
|
||||||
|
|
||||||
|
sht4x.begin(Wire);
|
||||||
|
|
||||||
|
uint32_t serialNumber;
|
||||||
|
error = sht4x.serialNumber(serialNumber);
|
||||||
|
if (error) {
|
||||||
|
Serial.print("Error trying to execute serialNumber(): ");
|
||||||
|
errorToString(error, errorMessage, 256);
|
||||||
|
Serial.println(errorMessage);
|
||||||
|
} else {
|
||||||
|
Serial.print("Serial Number: ");
|
||||||
|
Serial.println(serialNumber);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop() {
|
||||||
|
uint16_t error;
|
||||||
|
char errorMessage[256];
|
||||||
|
|
||||||
|
delay(1000);
|
||||||
|
|
||||||
|
float temperature;
|
||||||
|
float humidity;
|
||||||
|
error = sht4x.measureHighPrecision(temperature, humidity);
|
||||||
|
if (error) {
|
||||||
|
Serial.print("Error trying to execute measureHighPrecision(): ");
|
||||||
|
errorToString(error, errorMessage, 256);
|
||||||
|
Serial.println(errorMessage);
|
||||||
|
} else {
|
||||||
|
Serial.print("Temperature:");
|
||||||
|
Serial.print(temperature);
|
||||||
|
Serial.print("\t");
|
||||||
|
Serial.print("Humidity:");
|
||||||
|
Serial.println(humidity);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Open the serial monitor of Arduino IDE and select the baud rate as 115200 and observe the result.
|
||||||
|
|
||||||
|
<div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/Wio-Terminal-Developer-for-helium/166.png" style={{width:700, height:'auto'}}/></div>
|
||||||
|
|
||||||
|
|
||||||
|
## Introduction to SenseCAP HTTPS API -- Upload Sensor Data
|
||||||
|
|
||||||
|
Now that we know how to get data from the SHT40 sensor, let's start by learning the following API call rules for the SenseCAP platform. You can read about using the SenseCAP API by clicking the button below to jump directly to the SenseCAP Documentation Center.
|
||||||
|
|
||||||
|
- [SenseCAP Document Center](https://sensecap-docs.seeed.cc/httpapi_quickstart.html)
|
||||||
|
|
||||||
|
The basic principle of SenseCAP to receive sensor data is to use EUI, Key as the authentication information and report the device data by POST.
|
||||||
|
|
||||||
|
HTTPS Server Address:
|
||||||
|
|
||||||
|
```
|
||||||
|
https://sensecap.seeed.cc/deviceapi
|
||||||
|
```
|
||||||
|
|
||||||
|
### About Header
|
||||||
|
|
||||||
|
In POST, you need to add the authentication information in the Header, which is the base64 encrypted data of the device's **EUI** and **Key** in the following basic format.
|
||||||
|
|
||||||
|
```
|
||||||
|
authorization = Device base64(EUI:Key)
|
||||||
|
```
|
||||||
|
|
||||||
|
### About Interface
|
||||||
|
|
||||||
|
The server path to be used by the device to report sensor data is: `/kit/message_uplink`, the mode is **POST**, and the following request parameters are available and allowed.
|
||||||
|
|
||||||
|
<table align="center">
|
||||||
|
<tr>
|
||||||
|
<th>Name</th>
|
||||||
|
<th>Type</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- requestId</td>
|
||||||
|
<td align="center">string</td>
|
||||||
|
<td align="center">The uuidv4 is generated on the device side each time data is reported, ensuring that the value is different for each message.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- timestamp</td>
|
||||||
|
<td align="center">string</td>
|
||||||
|
<td align="center">Millisecond timestamp when the message was sent.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- intent</td>
|
||||||
|
<td align="center">string</td>
|
||||||
|
<td align="center">Currently fixed to "event".</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- deviceEui</td>
|
||||||
|
<td align="center">string</td>
|
||||||
|
<td align="center">Device EUI.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- deviceKey</td>
|
||||||
|
<td align="center">string</td>
|
||||||
|
<td align="center">Device Key.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- events</td>
|
||||||
|
<td align="center">[object]</td>
|
||||||
|
<td align="center">An array of events where data collection and device status is reported.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">-- name</td>
|
||||||
|
<td align="center">string</td>
|
||||||
|
<td align="center">Event Name.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">-- value</td>
|
||||||
|
<td align="center">[object]</td>
|
||||||
|
<td align="center">Event Value.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">-- timestamp</td>
|
||||||
|
<td align="center">string</td>
|
||||||
|
<td align="center">Millisecond timestamp at the time of data collection.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
The following is an example of sending sensor upload data.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"requestId": "aaaa-aaaa-aaaa-aaaa",
|
||||||
|
"timestamp": "1691026791405",
|
||||||
|
"intent": "event",
|
||||||
|
"deviceEui": "2CF7xxxxxxx00002",
|
||||||
|
"deviceKey": "38xxxxxxxxxxxxxxxxxxxxC0EE76C3CD",
|
||||||
|
"events": [
|
||||||
|
{
|
||||||
|
"name": "measure-sensor",
|
||||||
|
"value": [
|
||||||
|
{
|
||||||
|
"channel": "1",
|
||||||
|
"measurements": {
|
||||||
|
"4097": "31.38",
|
||||||
|
"4098": "59.60"
|
||||||
|
},
|
||||||
|
"measureTime": "1691026791405"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "update-channel-info",
|
||||||
|
"value": [
|
||||||
|
{
|
||||||
|
"channel": "1",
|
||||||
|
"sensorType": "1001",
|
||||||
|
"status": "normal"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"timestamp": "1691026791405"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Upload temperature and humidity data to SenseCAP
|
||||||
|
|
||||||
|
Once we understand the above rules, we can start writing the HTTPS program to upload the temperature and humidity data of our SHT40 for SenseCAP.
|
||||||
|
|
||||||
|
### Step 1. Register and login to SenseCAP
|
||||||
|
|
||||||
|
You can click on the link below to go directly to the SenseCAP International site. If this is your first time using SenseCAP's services, you may need to register for an account.
|
||||||
|
|
||||||
|
- [SenseCAP Website](https://sensecap.seeed.cc)
|
||||||
|
|
||||||
|
Logging in to SenseCAP takes you to the console screen. We need to add a kit of our own, please click **DevelopKit** on the left menu bar.
|
||||||
|
|
||||||
|
<div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/xiao-connect-sensecap/3.png" style={{width:1000, height:'auto'}}/></div>
|
||||||
|
|
||||||
|
Then click **Create DevelopKit** in the upper left.
|
||||||
|
|
||||||
|
<div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/xiao-connect-sensecap/4.png" style={{width:1000, height:'auto'}}/></div>
|
||||||
|
|
||||||
|
Then just select the **MIG Develop Kit** and click the **Confirm** button.
|
||||||
|
|
||||||
|
<div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/xiao-connect-sensecap/5.png" style={{width:500, height:'auto'}}/></div>
|
||||||
|
|
||||||
|
Next, you'll be able to see the device you created in the dashboard, usually the first one. Clicking on the "Connect" button for that device will display the **EUI** and **KEY** information for that device. Please save them, we will use them in the next steps.
|
||||||
|
|
||||||
|
<div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/xiao-connect-sensecap/6.png" style={{width:1000, height:'auto'}}/></div>
|
||||||
|
|
||||||
|
### Step 2. Obtaining Forensic Information
|
||||||
|
|
||||||
|
SenseCAP's interface for authentication information requires Base64-based **EUI:KEY** encryption.
|
||||||
|
|
||||||
|
For example, your EUI is `2CF7F11003900000` and Key is `06C42483D7155E7006C42483D7155E70`. then you can get the Base64 encrypted forensic information by the following commands in the terminal.
|
||||||
|
|
||||||
|
```
|
||||||
|
echo -n 2CF7F11003900000:06C42483D7155E7006C42483D7155E70 |base64
|
||||||
|
|
||||||
|
>>> MkNGN0YxMTAwMzkwMDAwMDowNkM0MjQ4M0Q3MTU1RTcwMDZDNDI0ODNENzE1NUU3MA==
|
||||||
|
```
|
||||||
|
|
||||||
|
Please keep the authentication information, we will use it as the **apiKey** in the program later.
|
||||||
|
|
||||||
|
### Step 3. Obtaining the number of the sensor type
|
||||||
|
|
||||||
|
Included in the upload is the number of the sensor type and sensor name that we are reporting. This is so that SenseCAP knows what sensor we are uploading data from and what units the data is in.
|
||||||
|
|
||||||
|
For this section, please refer to the numbered cross-reference table of sensors and values provided in the SenseCAP Documentation Center.
|
||||||
|
|
||||||
|
- [List of Measurement IDs](https://sensecap-docs.seeed.cc/measurement_list.html)
|
||||||
|
|
||||||
|
- [List of Sensor Types](https://sensecap-docs.seeed.cc/sensor_types_list.html)
|
||||||
|
|
||||||
|
How to use these two documents, we will use the SHT40 sensor used in this article as an example, to give you an introduction to explain. The SHT40 sensor is a sensor that can measure both temperature and humidity data. So he has a code for the sensor type and two codes for the (temperature, humidity) values.
|
||||||
|
|
||||||
|
The code for a sensor type we need to look up in [List of Sensor Types](https://sensecap-docs.seeed.cc/sensor_types_list.html). We found a temperature and humidity sensor with the code **1001**.
|
||||||
|
|
||||||
|
<div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/xiao-connect-sensecap/7.png" style={{width:700, height:'auto'}}/></div>
|
||||||
|
|
||||||
|
The codes for the sensor values we're talking about are actually the Measurement IDs in the diagram, **4097** and **4098**. you can also find them in the [List of Measurement IDs](https://sensecap-docs.seeed.cc/measurement_list.html) and check to see if the units of these values match your sensor.
|
||||||
|
|
||||||
|
<div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/xiao-connect-sensecap/8.png" style={{width:700, height:'auto'}}/></div>
|
||||||
|
|
||||||
|
:::note
|
||||||
|
If you can't find the right type of sensor for you in the table. You may need to use a custom type with a sensor number of **4165** to **4174**. the sensor value may be unitless.
|
||||||
|
:::
|
||||||
|
|
||||||
|
### Step 4. Install the necessary libraries
|
||||||
|
|
||||||
|
First is the **NTPClient** library, which can use XIAO networking to get the current timestamp.
|
||||||
|
|
||||||
|
<div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/xiao-connect-sensecap/9.png" style={{width:1000, height:'auto'}}/></div>
|
||||||
|
|
||||||
|
Next is the **ArduinoJson** library, which makes it easier to help us parse what SenseCAP returns to us.
|
||||||
|
|
||||||
|
<div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/xiao-connect-sensecap/10.png" style={{width:1000, height:'auto'}}/></div>
|
||||||
|
|
||||||
|
### Step 5. Uploading sensor data through the program
|
||||||
|
|
||||||
|
The following is the procedure for uploading SHT40 data. Please note that the following macro definitions should only be used if they are modified to suit your situation.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
const char* ssid = "YOUR-WIFI-NAME";
|
||||||
|
const char* password = "YOUR-WIFI-PASSWORD";
|
||||||
|
const char* apiKey = "YOUR-DEVICE-EUI&KEY-BASE64";
|
||||||
|
const char* deviceEUI = "YOUR-DEVICE-EUI";
|
||||||
|
const char* deviceKey = "YOUR-DEVICE-KEY";
|
||||||
|
const char* dataNum_1 = "4097"; // Air temperature
|
||||||
|
const char* dataNum_2 = "4098"; // Air humidity
|
||||||
|
const char* sensorType = "1001"; // Air temperature and humidity sensors
|
||||||
|
```
|
||||||
|
|
||||||
|
Where ssid and password refer to your network name and password. apiKey refers to the forensic information we obtained in **Step 2**. deviceEUI and deviceKey are your device EUI and Key, which were also obtained in **Step 2**.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
#include <Arduino.h>
|
||||||
|
#include <SensirionI2CSht4x.h>
|
||||||
|
#include <Wire.h>
|
||||||
|
#include "WiFi.h"
|
||||||
|
#include <HTTPClient.h>
|
||||||
|
#include <ArduinoJson.h>
|
||||||
|
#include <WiFiUdp.h>
|
||||||
|
#include <NTPClient.h>
|
||||||
|
|
||||||
|
// Replace with your devive content
|
||||||
|
const char* ssid = "YOUR-WIFI-NAME";
|
||||||
|
const char* password = "YOUR-WIFI-PASSWORD";
|
||||||
|
const char* apiKey = "YOUR-DEVICE-EUI&KEY-BASE64";
|
||||||
|
const char* deviceEUI = "YOUR-DEVICE-EUI";
|
||||||
|
const char* deviceKey = "YOUR-DEVICE-KEY";
|
||||||
|
const char* dataNum_1 = "4097"; // Air temperature
|
||||||
|
const char* dataNum_2 = "4098"; // Air humidity
|
||||||
|
const char* sensorType = "1001"; // Air temperature and humidity sensors
|
||||||
|
|
||||||
|
const char* ntpServer = "pool.ntp.org";
|
||||||
|
|
||||||
|
WiFiUDP ntpUDP;
|
||||||
|
NTPClient timeClient(ntpUDP, ntpServer);
|
||||||
|
|
||||||
|
char sensecapServer[] = "https://sensecap.seeed.cc/deviceapi/kit/message_uplink";
|
||||||
|
|
||||||
|
SensirionI2CSht4x sht4x;
|
||||||
|
|
||||||
|
void wifiConnect(){
|
||||||
|
WiFi.begin(ssid, password);
|
||||||
|
Serial.print("Connecting to ");
|
||||||
|
Serial.println(ssid);
|
||||||
|
while(WiFi.status() != WL_CONNECTED) {
|
||||||
|
delay(500);
|
||||||
|
Serial.print(".");
|
||||||
|
}
|
||||||
|
Serial.println();
|
||||||
|
Serial.println("WiFi connected!");
|
||||||
|
Serial.println(WiFi.localIP());
|
||||||
|
}
|
||||||
|
|
||||||
|
void setup() {
|
||||||
|
Serial.begin(115200);
|
||||||
|
while (!Serial) {
|
||||||
|
delay(100);
|
||||||
|
}
|
||||||
|
|
||||||
|
Wire.begin();
|
||||||
|
|
||||||
|
uint16_t error;
|
||||||
|
char errorMessage[256];
|
||||||
|
|
||||||
|
sht4x.begin(Wire);
|
||||||
|
|
||||||
|
uint32_t serialNumber;
|
||||||
|
error = sht4x.serialNumber(serialNumber);
|
||||||
|
if (error) {
|
||||||
|
Serial.print("Error trying to execute serialNumber(): ");
|
||||||
|
errorToString(error, errorMessage, 256);
|
||||||
|
Serial.println(errorMessage);
|
||||||
|
} else {
|
||||||
|
Serial.print("Serial Number: ");
|
||||||
|
Serial.println(serialNumber);
|
||||||
|
}
|
||||||
|
|
||||||
|
wifiConnect();
|
||||||
|
|
||||||
|
timeClient.begin(); // Initialize the NTP client
|
||||||
|
timeClient.update(); // update timestamp
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop() {
|
||||||
|
uint16_t error;
|
||||||
|
char errorMessage[256];
|
||||||
|
|
||||||
|
delay(1000);
|
||||||
|
|
||||||
|
float temperature;
|
||||||
|
float humidity;
|
||||||
|
error = sht4x.measureHighPrecision(temperature, humidity);
|
||||||
|
if (error) {
|
||||||
|
Serial.print("Error trying to execute measureHighPrecision(): ");
|
||||||
|
errorToString(error, errorMessage, 256);
|
||||||
|
Serial.println(errorMessage);
|
||||||
|
} else {
|
||||||
|
Serial.print("Temperature:");
|
||||||
|
Serial.print(temperature);
|
||||||
|
Serial.print("\t");
|
||||||
|
Serial.print("Humidity:");
|
||||||
|
Serial.println(humidity);
|
||||||
|
}
|
||||||
|
|
||||||
|
HTTPClient https;
|
||||||
|
if (https.begin(sensecapServer)) { // HTTPS
|
||||||
|
https.addHeader("Content-Type", "application/json");
|
||||||
|
String author = String("Device ") + apiKey;
|
||||||
|
https.addHeader("authorization", author);
|
||||||
|
String payload = String("{\"requestId\": \"aaaa-aaaa-aaaa-aaaa\", \"timestamp\": \"");
|
||||||
|
timeClient.update(); // update timestamp
|
||||||
|
uint64_t timestamp = timeClient.getEpochTime() * 1000ULL; // GET timestamp
|
||||||
|
payload += String(timestamp);
|
||||||
|
payload += String("\", \"intent\": \"event\", \"deviceEui\": \"");
|
||||||
|
payload += deviceEUI;
|
||||||
|
payload += String("\", \"deviceKey\": \"");
|
||||||
|
payload += deviceKey;
|
||||||
|
payload += String("\", \"events\": [{\"name\": \"measure-sensor\", \"value\": [{\"channel\": \"1\", \"measurements\": {\"");
|
||||||
|
payload += dataNum_1;
|
||||||
|
payload += String("\": \"");
|
||||||
|
payload += String(temperature);
|
||||||
|
payload += String("\", \"");
|
||||||
|
payload += dataNum_2;
|
||||||
|
payload += String("\": \"");
|
||||||
|
payload += String(humidity);
|
||||||
|
payload += String("\"}, \"measureTime\": \"");
|
||||||
|
payload += String(timestamp);
|
||||||
|
payload += String("\"}]}, {\"name\": \"update-channel-info\", \"value\": [{\"channel\": \"1\", \"sensorType\": \"");
|
||||||
|
payload += sensorType;
|
||||||
|
payload += String("\", \"status\": \"normal\"}], \"timestamp\": \"");
|
||||||
|
payload += String(timestamp);
|
||||||
|
payload += String("\"}]}");
|
||||||
|
Serial.println(payload);
|
||||||
|
int httpCode = https.POST(payload); // start connection and send HTTP header
|
||||||
|
if (httpCode == HTTP_CODE_OK || httpCode == HTTP_CODE_MOVED_PERMANENTLY) {
|
||||||
|
String payload = https.getString();
|
||||||
|
Serial.println(payload);
|
||||||
|
}
|
||||||
|
else{
|
||||||
|
Serial.print("[HTTP] ERROR: ");
|
||||||
|
Serial.println(httpCode);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else{
|
||||||
|
Serial.println("[HTTPS] Unable to connect");
|
||||||
|
delay(1000);
|
||||||
|
}
|
||||||
|
delay(300000);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Turn on the serial monitor, when you turn it on, the program will start to execute, when you receive the response as shown in the figure, it means that SenseCAP has successfully received one of your data uploads.
|
||||||
|
|
||||||
|
<div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/xiao-connect-sensecap/11.png" style={{width:1000, height:'auto'}}/></div>
|
||||||
|
|
||||||
|
:::tip
|
||||||
|
The minimum time interval for SenseCAP to receive data uploads is five minutes.
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Introduction to SenseCAP HTTPS API -- Getting AI Advice
|
||||||
|
|
||||||
|
Next, let's learn how to use the SenseCAP AI API below. Use our sensor data over time as a reference to get suggestions from the AI.
|
||||||
|
|
||||||
|
The interface call process for SenseCAP AI is roughly as follows.
|
||||||
|
- Obtain the device and measurement value IDs under the account that are supported for use in AIGC via the interface I.
|
||||||
|
- Using the result obtained by interface I as one of the parameters, interface II is called to obtain the AIGC result.
|
||||||
|
- Since the AIGC generation time may be long, the interface I will return a **resource_id** when it is called for the first time, and then the front-end will use the **resource_id** to poll for the result of the response. When the code of the response is **11338**, it means that the AIGC is still in the process of inference, and the interface II needs to be called again with the **resource_id** until the final result is returned.
|
||||||
|
- Interface II has a flow limit of up to ten requests within five minutes for the same account.
|
||||||
|
|
||||||
|
HTTPS Server Address:
|
||||||
|
```
|
||||||
|
https://sensecap.seeed.cc/openapi
|
||||||
|
```
|
||||||
|
|
||||||
|
### About Interface I
|
||||||
|
|
||||||
|
The server path to be used by the device to report sensor data is: `/ai/view_suggestion_by_measurements`, the mode is **POST**, and the following request parameters are available and allowed.
|
||||||
|
|
||||||
|
<table align="center">
|
||||||
|
<tr>
|
||||||
|
<th>Name</th>
|
||||||
|
<th>Description</th>
|
||||||
|
<th>Note</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- lang</td>
|
||||||
|
<td align="center">Select language</td>
|
||||||
|
<td align="center">1:Chinese, 2:English. Default Chinese.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- location</td>
|
||||||
|
<td align="center">Location</td>
|
||||||
|
<td align="center">Location, e.g. "Shenzhen".</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- crop</td>
|
||||||
|
<td align="center">Crop or animal</td>
|
||||||
|
<td align="center">Crop or animal to be consulted, e.g. "apple".</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- time_range</td>
|
||||||
|
<td align="center">Device data inquiry time</td>
|
||||||
|
<td align="center">1: 30 days 2: 180 days 3: 360 days. Default 30 days</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- measurements</td>
|
||||||
|
<td align="center">Device measurement types</td>
|
||||||
|
<td align="center">Up to six</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">-- dev_eui</td>
|
||||||
|
<td align="center">Device EUI</td>
|
||||||
|
<td align="center"></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">-- channel_measurement</td>
|
||||||
|
<td align="center"></td>
|
||||||
|
<td align="center"></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">--- channel_index</td>
|
||||||
|
<td align="center">Channel number</td>
|
||||||
|
<td align="center">This value is currently fixed at 1.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">--- measurement_ids</td>
|
||||||
|
<td align="center">Measurement value number</td>
|
||||||
|
<td align="center"></td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
The following is an example of calling the Interface I.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"lang": "2",
|
||||||
|
"crop": "apple",
|
||||||
|
"location": "Shenzhen",
|
||||||
|
"time_range": "1",
|
||||||
|
"measurements": [
|
||||||
|
{
|
||||||
|
"dev_eui": "2CF7F18215100010",
|
||||||
|
"channel_measurement": [
|
||||||
|
{
|
||||||
|
"channel_index": "1",
|
||||||
|
"measurement_ids": [
|
||||||
|
"4097",
|
||||||
|
"4098"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"dev_eui": "2CF7F1C043400103",
|
||||||
|
"channel_measurement": [
|
||||||
|
{
|
||||||
|
"channel_index": "1",
|
||||||
|
"measurement_ids": [
|
||||||
|
"4097"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### About Interface II
|
||||||
|
|
||||||
|
The structure and framework of Interface I is largely the same as Interface II, with the only difference being the addition of an extra **resource_id** at the end. The following request parameters are available and allowed.
|
||||||
|
|
||||||
|
<table align="center">
|
||||||
|
<tr>
|
||||||
|
<th>Name</th>
|
||||||
|
<th>Description</th>
|
||||||
|
<th>Note</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- lang</td>
|
||||||
|
<td align="center">Select language</td>
|
||||||
|
<td align="center">1:Chinese, 2:English. Default Chinese.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- location</td>
|
||||||
|
<td align="center">Location</td>
|
||||||
|
<td align="center">Location, e.g. "Shenzhen".</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- crop</td>
|
||||||
|
<td align="center">Crop or animal</td>
|
||||||
|
<td align="center">Crop or animal to be consulted, e.g. "apple".</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- time_range</td>
|
||||||
|
<td align="center">Device data inquiry time</td>
|
||||||
|
<td align="center">1: 30 days 2: 180 days 3: 360 days. Default 30 days</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- measurements</td>
|
||||||
|
<td align="center">Device measurement types</td>
|
||||||
|
<td align="center">Up to six</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">-- dev_eui</td>
|
||||||
|
<td align="center">Device EUI</td>
|
||||||
|
<td align="center"></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">-- channel_measurement</td>
|
||||||
|
<td align="center"></td>
|
||||||
|
<td align="center"></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">--- channel_index</td>
|
||||||
|
<td align="center">Channel number</td>
|
||||||
|
<td align="center">This value is currently fixed at 1.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">--- measurement_ids</td>
|
||||||
|
<td align="center">Measurement value number</td>
|
||||||
|
<td align="center"></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td align="center">- resource_id</td>
|
||||||
|
<td align="center">Cached Credentials</td>
|
||||||
|
<td align="center">In the case where a question has been asked and the returned result is obtained, carry this parameter to poll the backend until the result of the AI is returned.</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
The following is an example of getting AI advice.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"lang": "2",
|
||||||
|
"crop": "apple",
|
||||||
|
"location": "Shenzhen",
|
||||||
|
"time_range": "1",
|
||||||
|
"measurements": [
|
||||||
|
{
|
||||||
|
"dev_eui": "2CF7F18215100010",
|
||||||
|
"channel_measurement": [
|
||||||
|
{
|
||||||
|
"channel_index": "1",
|
||||||
|
"measurement_ids": [
|
||||||
|
"4097",
|
||||||
|
"4098"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"dev_eui": "2CF7F1C043400103",
|
||||||
|
"channel_measurement": [
|
||||||
|
{
|
||||||
|
"channel_index": "1",
|
||||||
|
"measurement_ids": [
|
||||||
|
"4097"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"resource_id": "openAi:ask:424326279298784:1691053698953"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## XIAO ESP32C3 Getting SenseCAP AI Answer
|
||||||
|
|
||||||
|
### Step 6. Create API Access
|
||||||
|
|
||||||
|
If you want to call the AIGC interface of SenseCAP, then you need to prepare the API ID and API Access Key in SenseCAP. Select **Access API keys** in the left menu bar of the dashboard. Then click **Create Access Key** at the top.
|
||||||
|
|
||||||
|
<div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/xiao-connect-sensecap/12.png" style={{width:1000, height:'auto'}}/></div>
|
||||||
|
|
||||||
|
Copy the created **Access Key ID** and **Access API Key**. Please keep them safe and we will use them in the following steps.
|
||||||
|
|
||||||
|
<div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/xiao-connect-sensecap/13.png" style={{width:1000, height:'auto'}}/></div>
|
||||||
|
|
||||||
|
|
||||||
|
### Step 7. Write and upload programs
|
||||||
|
|
||||||
|
Following the interface guidelines above, we can then write a program that allows SenseCAP to use the temperature and humidity data from our SHT40 to return planting recommendations to us.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
#include <Arduino.h>
|
||||||
|
#include <Wire.h>
|
||||||
|
#include "WiFi.h"
|
||||||
|
#include <HTTPClient.h>
|
||||||
|
#include <base64.h>
|
||||||
|
#include <ArduinoJson.h>
|
||||||
|
|
||||||
|
//#define DEBUG 1
|
||||||
|
|
||||||
|
// Replace with your devive content
|
||||||
|
const char* ssid = "YOUR-WIFI-NAME";
|
||||||
|
const char* password = "YOUR-WIFI-PASSWORD";
|
||||||
|
const char* username = "YOUR-API-ID";
|
||||||
|
const char* accesskey = "YOUR-ACCESS-API-KEY";
|
||||||
|
const char* deviceEUI = "YOUR-DEVICE-EUI";
|
||||||
|
|
||||||
|
const char* crop = "apple";
|
||||||
|
const char* location = "Shenzhen";
|
||||||
|
const char* timerange = "1";
|
||||||
|
const char* dataNum_1 = "4097"; //Air temperature
|
||||||
|
const char* dataNum_2 = "4098"; //Air humidity
|
||||||
|
|
||||||
|
char sensecapAIServer[] = "https://sensecap.seeed.cc/openapi/ai/view_suggestion_by_measurements";
|
||||||
|
|
||||||
|
void wifiConnect(){
|
||||||
|
WiFi.begin(ssid, password);
|
||||||
|
Serial.print("Connecting to ");
|
||||||
|
Serial.println(ssid);
|
||||||
|
while(WiFi.status() != WL_CONNECTED) {
|
||||||
|
delay(500);
|
||||||
|
Serial.print(".");
|
||||||
|
}
|
||||||
|
Serial.println();
|
||||||
|
Serial.println("WiFi connected!");
|
||||||
|
Serial.println(WiFi.localIP());
|
||||||
|
}
|
||||||
|
|
||||||
|
void setup() {
|
||||||
|
// put your setup code here, to run once:
|
||||||
|
Serial.begin(115200);
|
||||||
|
while (!Serial) {
|
||||||
|
delay(100);
|
||||||
|
}
|
||||||
|
wifiConnect();
|
||||||
|
}
|
||||||
|
|
||||||
|
String splicePayload(int mode, String resource_id = ""){
|
||||||
|
String payload = String("{\"lang\": \"2\", \"crop\": \""); // 1:Chinese 2:English
|
||||||
|
payload += crop;
|
||||||
|
payload += String("\", \"location\": \"");
|
||||||
|
payload += location;
|
||||||
|
payload += String("\", \"time_range\": \""); // 1:30 days, 2:180 days, 3:360 days
|
||||||
|
payload += timerange;
|
||||||
|
payload += String("\", \"measurements\": [{\"dev_eui\": \"");
|
||||||
|
payload += deviceEUI;
|
||||||
|
payload += String("\", \"channel_measurement\": [{\"channel_index\": \"1\", \"measurement_ids\": [\"");
|
||||||
|
payload += dataNum_1;
|
||||||
|
payload += String("\", \"");
|
||||||
|
payload += dataNum_2;
|
||||||
|
payload += String("\"]}]}");
|
||||||
|
|
||||||
|
//If you need values for other sensors
|
||||||
|
// payload += String(", {\"dev_eui\": \"");
|
||||||
|
// payload += deviceEUI_2;
|
||||||
|
// payload += String("\", \"channel_measurement\": [{\"channel_index\": \"1\", \"measurement_ids\": [\"");
|
||||||
|
// payload += dataNum_3;
|
||||||
|
// payload += String("\"]}]}");
|
||||||
|
|
||||||
|
if(mode == 1){
|
||||||
|
payload += String("]}");
|
||||||
|
}
|
||||||
|
else if(mode == 2){
|
||||||
|
// If a query code has been obtained. mode = 2
|
||||||
|
payload += String("], \"resource_id\": \"");
|
||||||
|
payload += resource_id;
|
||||||
|
payload += String("\"}");
|
||||||
|
}
|
||||||
|
|
||||||
|
Serial.println(payload);
|
||||||
|
return payload;
|
||||||
|
}
|
||||||
|
|
||||||
|
void loop() {
|
||||||
|
// put your main code here, to run repeatedly:
|
||||||
|
HTTPClient https;
|
||||||
|
if (https.begin(sensecapAIServer)) { // HTTPS
|
||||||
|
https.addHeader("Content-Type", "application/json");
|
||||||
|
String base64Credentials = base64::encode("YOUR-API-ID:YOUR-ACCESS-API-KEY");
|
||||||
|
https.addHeader("Authorization", "Basic " + base64Credentials);
|
||||||
|
|
||||||
|
String payload = splicePayload(1);
|
||||||
|
|
||||||
|
int httpCode = https.POST(payload); // start connection and send HTTP header
|
||||||
|
if (httpCode == HTTP_CODE_OK || httpCode == HTTP_CODE_MOVED_PERMANENTLY) {
|
||||||
|
String response = https.getString();
|
||||||
|
#ifdef DEBUG
|
||||||
|
Serial.println(response);
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// get resource_id
|
||||||
|
DynamicJsonDocument doc(1024);
|
||||||
|
deserializeJson(doc, response);
|
||||||
|
String resource_id = doc["data"]["resource_id"].as<String>();
|
||||||
|
Serial.println("resource_id: " + resource_id);
|
||||||
|
|
||||||
|
String payload = splicePayload(2, resource_id);
|
||||||
|
|
||||||
|
do{
|
||||||
|
delay(2000);
|
||||||
|
https.addHeader("Content-Type", "application/json");
|
||||||
|
String base64Credentials = base64::encode("YOUR-API-ID:YOUR-ACCESS-API-KEY");
|
||||||
|
https.addHeader("Authorization", "Basic " + base64Credentials);
|
||||||
|
|
||||||
|
int httpCode = https.POST(payload); // start connection and send HTTP header
|
||||||
|
if (httpCode == HTTP_CODE_OK || httpCode == HTTP_CODE_MOVED_PERMANENTLY) {
|
||||||
|
String response = https.getString();
|
||||||
|
#ifdef DEBUG
|
||||||
|
Serial.println(response);
|
||||||
|
#endif
|
||||||
|
|
||||||
|
// Parsing JSON Responses
|
||||||
|
DynamicJsonDocument doc(1024);
|
||||||
|
deserializeJson(doc, response);
|
||||||
|
String code = doc["code"].as<String>();
|
||||||
|
Serial.println("status: " + code);
|
||||||
|
if(code == "0"){
|
||||||
|
DynamicJsonDocument doc(1024);
|
||||||
|
deserializeJson(doc, response);
|
||||||
|
String suggest = doc["data"].as<String>();
|
||||||
|
Serial.println("SenseCAP AI gives the following planting advice: ");
|
||||||
|
Serial.println(suggest);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
else if(code == "11396"){
|
||||||
|
Serial.println("Timeout. Please wait five minutes.");
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
else Serial.println("Waiting for a reply...");
|
||||||
|
}
|
||||||
|
}while(1);
|
||||||
|
}
|
||||||
|
else{
|
||||||
|
Serial.print("[HTTP] ERROR: ");
|
||||||
|
Serial.println(httpCode);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
else{
|
||||||
|
Serial.println("[HTTPS] Unable to connect");
|
||||||
|
delay(1000);
|
||||||
|
}
|
||||||
|
Serial.println("The next query will be in five minutes, so please do not query too often to avoid having your account restricted from use!");
|
||||||
|
delay(300000);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Here, there are some parameters to keep an eye on. At the beginning of the code, a macro definition `DEBUG` is commented out. if this line is uncommented, then the program can be executed to print the message returned each time SenseCAP returns.
|
||||||
|
|
||||||
|
Below `DEBUG` is the information that needs to be changed depending on your account and device. For example, if you are not growing apples and the location is not Shenzhen, then you need to change it to suit your situation.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
// Replace with your devive content
|
||||||
|
const char* ssid = "YOUR-WIFI-NAME";
|
||||||
|
const char* password = "YOUR-WIFI-PASSWORD";
|
||||||
|
const char* deviceEUI = "YOUR-DEVICE-EUI";
|
||||||
|
|
||||||
|
const char* crop = "apple";
|
||||||
|
const char* location = "Shenzhen";
|
||||||
|
const char* timerange = "1";
|
||||||
|
const char* dataNum_1 = "4097"; //Air temperature
|
||||||
|
const char* dataNum_2 = "4098"; //Air humidity
|
||||||
|
```
|
||||||
|
|
||||||
|
In addition to this, there are two lines in the code that parse the Access API.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
String base64Credentials = base64::encode("YOUR-API-ID:YOUR-ACCESS-API-KEY");
|
||||||
|
```
|
||||||
|
|
||||||
|
For example, the API ID and API Key you obtained in **step 6** are `N0AV094KBPH1J9PX` and `5DFA8167D23C499C86F61BDEFB901D4995B896A267054D7DAD590BF67FB9A219`, respectively. Then this line of code you should change to:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
String base64Credentials = base64::encode("N0AV094KBPH1J9PX:5DFA8167D23C499C86F61BDEFB901D4995B896A267054D7DAD590BF67FB9A219");
|
||||||
|
```
|
||||||
|
|
||||||
|
Upload this program and you will see the message upload and keep looping through the results of the answers returned by the AI until the results are returned.
|
||||||
|
|
||||||
|
<div style={{textAlign:'center'}}><img src="https://files.seeedstudio.com/wiki/xiao-connect-sensecap/14.png" style={{width:700, height:'auto'}}/></div>
|
||||||
|
|
||||||
|
At this point, congratulations you have mastered all the knowledge and content of XIAO access SenseCAP, we very much welcome you to use our XIAO and SenseCAP to utilize more of your creativity!
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
### Q1: Why am I getting null results after getting AI answers?
|
||||||
|
|
||||||
|
This may be due to an interface timeout, you can wait until the next query is sent before checking the results. Please note that this result can only be fetched once, after that the result is immediately erased and can no longer be queried.
|
||||||
|
|
||||||
|
## Tech Support & Product Discussion
|
||||||
|
|
||||||
|
Thank you for choosing our products! We are here to provide you with different support to ensure that your experience with our products is as smooth as possible. We offer several communication channels to cater to different preferences and needs.
|
||||||
|
|
||||||
|
<div class="table-center">
|
||||||
|
<div class="button_tech_support_container">
|
||||||
|
<a href="https://forum.seeedstudio.com/" class="button_forum"></a>
|
||||||
|
<a href="https://www.seeedstudio.com/contacts" class="button_email"></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="button_tech_support_container">
|
||||||
|
<a href="https://discord.gg/eWkprNDMU7" class="button_discord"></a>
|
||||||
|
<a href="https://github.com/Seeed-Studio/wiki-documents/discussions/69" class="button_discussion"></a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
78
docs/Cloud_Chain/SenseCAP_API/API_pricing.md
Normal file
@ -0,0 +1,78 @@
|
|||||||
|
---
|
||||||
|
description: SenseCAP API Pricing
|
||||||
|
title: SenseCAP API Pricing
|
||||||
|
keywords:
|
||||||
|
- Cloud and Chain
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
last_update:
|
||||||
|
date: 02/14/2023
|
||||||
|
author: Matthew
|
||||||
|
---
|
||||||
|
|
||||||
|
# SenseCAP API Pricing
|
||||||
|
|
||||||
|
===============
|
||||||
|
|
||||||
|
|
||||||
|
With SenseCAP Portal, you pay only for what you use with no minimum fees or mandatory service usage.
|
||||||
|
|
||||||
|
* um (up-message): The number of messages uploaded by the sensor.
|
||||||
|
* dm(download-message): The number of messages that get historical data through the API.
|
||||||
|
|
||||||
|
Rules
|
||||||
|
-----
|
||||||
|
|
||||||
|
1. Add a sensor device to each user account, and the system will distribute a certain amount of um and dm for free.
|
||||||
|
2. For each data uploaded by the sensor, 1 um is consumed.
|
||||||
|
3. Get a piece of historical data by HTTP, and consume 1 dm.
|
||||||
|
4. Subscription to sensor data by means of MQTT will not consume dm.
|
||||||
|
5. um /dm can purchase the recharge code online, and then input the recharge code in the account to complete the recharge.
|
||||||
|
6. When um/dm is 0, the system will send a message to remind the user of the overdue fee. If the time is more than 1 month, the account function will not be able to be used.
|
||||||
|
|
||||||
|
Free Tier
|
||||||
|
|
||||||
|
------------
|
||||||
|
|
||||||
|
| Device Type (one device) | um (up-message) | dm (download-message) |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| LoRaWAN Sensor Node | 100,000 | 1000,000 |
|
||||||
|
| SensorHub | 250,000 | 2,500,000 |
|
||||||
|
|
||||||
|
Fees
|
||||||
|
|
||||||
|
-------
|
||||||
|
|
||||||
|
| Pricing | um (up-message) | dm (download-message) |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| $ 0.99 | 100,000 | 1,000,000 |
|
||||||
|
|
||||||
|
Pre-paid
|
||||||
|
--------
|
||||||
|
|
||||||
|
Please contact the SenseCAP sales staff to recharge.
|
||||||
|
|
||||||
|
Tips
|
||||||
|
----
|
||||||
|
|
||||||
|
* It is recommended to subscribe to sensor data using MQTT without consuming the number of dm (download-message).
|
||||||
|
* The data upload of LoRaWAN Sensor is affected by the Internet (the gateway connects to Portal over the Internet). When access to the Internet is unstable, the Sensor Node will resend the data up to three times to ensure that the data can be successfully transmitted to the SenseCAP Portal. The Free Tier is based on the worst-case scenario of the network, so how long you use it depends on the situation.
|
||||||
|
|
||||||
|
Example
|
||||||
|
-------
|
||||||
|
|
||||||
|
According to device type and data upload interval, the approximate time available is as follows:
|
||||||
|
|
||||||
|
| Device Type (one device) | Data Interval | Time |
|
||||||
|
|-----------------------------------------|---------------|---------------|
|
||||||
|
| LoRaWAN Temperature and Humidity Sensor | 1 hour | 2 ~ 5 years |
|
||||||
|
| | 30 minutes | 1 ~ 2.5 years |
|
||||||
|
| | 5 minutes | 4 ~ 10 months |
|
||||||
|
| LoRaWAN Light Intensity Sensor | 1 hour | 4 ~ 10 years |
|
||||||
|
| | 30 minutes | 2 ~ 5 years |
|
||||||
|
| | 5 minutes | 8 ~ 20 months |
|
||||||
|
| SensorHub (5 types of measurements) | 1 hour | 5.6 years |
|
||||||
|
| | 30 minutes | 2.8 years |
|
||||||
|
| | 5 minutes | 11 months |
|
||||||
|
| SensorHub (7 types of measurements) | 1 hour | 4 years |
|
||||||
|
| | 30 minutes | 2 years |
|
||||||
|
| | 5 minutes | 8 months |
|
||||||
@ -0,0 +1,81 @@
|
|||||||
|
---
|
||||||
|
description: List_of_Device_Status_IDs
|
||||||
|
title: List of Device Status IDs
|
||||||
|
keywords:
|
||||||
|
- Cloud and Chain
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
last_update:
|
||||||
|
date: 02/14/2023
|
||||||
|
author: Matthew
|
||||||
|
---
|
||||||
|
|
||||||
|
|
||||||
|
<div class="post-header">
|
||||||
|
<h1>List of Device Status IDs</h1>
|
||||||
|
</div>
|
||||||
|
<div class="post-content">
|
||||||
|
<h2 id="sensorhub" class="clickable-header top-level-header">SensorHub</h2>
|
||||||
|
<i class="icon-arrow-up back-to-top"></i>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Status ID</th>
|
||||||
|
<th>Status name</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td>3000</td>
|
||||||
|
<td>battery</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>3009</td>
|
||||||
|
<td>Signal strength</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>3013</td>
|
||||||
|
<td>The onboard temperature</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>3017</td>
|
||||||
|
<td>Battery charging state(1:In the charging,2:Full charged,3:No full charged)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>3900</td>
|
||||||
|
<td>Data collection interval</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h2 id="lorapp-node" class="clickable-header top-level-header">LoraPP Node</h2>
|
||||||
|
<i class="icon-arrow-up back-to-top"></i>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Status ID</th>
|
||||||
|
<th>Status name</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td>3000</td>
|
||||||
|
<td>battery,Once a day</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h2 id="lorawan-node" class="clickable-header top-level-header">LoraWan Node</h2>
|
||||||
|
<i class="icon-arrow-up back-to-top"></i>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Status ID</th>
|
||||||
|
<th>Status name</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td>3000</td>
|
||||||
|
<td>battery,Once a day</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
68
docs/Cloud_Chain/SenseCAP_API/Appendix/List_of_Error_Code.md
Normal file
@ -0,0 +1,68 @@
|
|||||||
|
---
|
||||||
|
description: List_of_Error_Code
|
||||||
|
title: List of Error Code
|
||||||
|
keywords:
|
||||||
|
- Cloud and Chain
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
last_update:
|
||||||
|
date: 02/14/2023
|
||||||
|
author: Matthew
|
||||||
|
---
|
||||||
|
|
||||||
|
<div class="post-header">
|
||||||
|
<h1>List of Error Code</h1>
|
||||||
|
</div>
|
||||||
|
<div class="post-content">
|
||||||
|
<div id="toc"></div>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>code</th>
|
||||||
|
<th>msg</th>
|
||||||
|
<th>description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td>10000</td>
|
||||||
|
<td>Framework analysis error</td>
|
||||||
|
<td>An unknown error has occurred in the system</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>11201</td>
|
||||||
|
<td>You have no options permission</td>
|
||||||
|
<td>No operation permission</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>11202</td>
|
||||||
|
<td>Request parameters are invalid</td>
|
||||||
|
<td>Invalid request parameter</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>11203</td>
|
||||||
|
<td>Invalid device EUI</td>
|
||||||
|
<td>EUI format error</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>11317</td>
|
||||||
|
<td>Group not exist</td>
|
||||||
|
<td>Group does not exist</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>11327</td>
|
||||||
|
<td>Group is exists</td>
|
||||||
|
<td>Group already exists</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>11330</td>
|
||||||
|
<td>Check eui error</td>
|
||||||
|
<td>Device EUI does not exist</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>11334</td>
|
||||||
|
<td>Eui is bonded</td>
|
||||||
|
<td>The device has been bound</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
@ -0,0 +1,598 @@
|
|||||||
|
---
|
||||||
|
description: List_of_Measurement_IDs
|
||||||
|
title: List of Measurement IDs
|
||||||
|
keywords:
|
||||||
|
- Cloud and Chain
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
last_update:
|
||||||
|
date: 02/14/2023
|
||||||
|
author: Matthew
|
||||||
|
---
|
||||||
|
|
||||||
|
<div class="post-header">
|
||||||
|
<h1>List of Measurement IDs</h1>
|
||||||
|
</div>
|
||||||
|
<div class="post-content">
|
||||||
|
<div id="toc"></div>
|
||||||
|
<div>
|
||||||
|
<div id="di"></div>
|
||||||
|
<table id="tb" border="1">
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<th>Measurement ID</th>
|
||||||
|
<th>Measurement Name</th>
|
||||||
|
<th>Value Range</th>
|
||||||
|
<th>Unit</th>
|
||||||
|
<th>Remark</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4097</td>
|
||||||
|
<td>Air Temperature</td>
|
||||||
|
<td>-40~90</td>
|
||||||
|
<td>℃</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4098</td>
|
||||||
|
<td>Air Humidity</td>
|
||||||
|
<td>0~100</td>
|
||||||
|
<td>% RH</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4099</td>
|
||||||
|
<td>Light Intensity</td>
|
||||||
|
<td>0~188000</td>
|
||||||
|
<td>Lux</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4100</td>
|
||||||
|
<td>CO2</td>
|
||||||
|
<td>0~10000</td>
|
||||||
|
<td>ppm</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4101</td>
|
||||||
|
<td>Barometric Pressure</td>
|
||||||
|
<td>300~1100000</td>
|
||||||
|
<td>Pa</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4102</td>
|
||||||
|
<td>Soil Temperature</td>
|
||||||
|
<td>-30~70</td>
|
||||||
|
<td>℃</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4103</td>
|
||||||
|
<td>Soil Moisture</td>
|
||||||
|
<td>0~100</td>
|
||||||
|
<td>%</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4104</td>
|
||||||
|
<td>Wind Direction</td>
|
||||||
|
<td>0~360</td>
|
||||||
|
<td>°</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4105</td>
|
||||||
|
<td>Wind Speed</td>
|
||||||
|
<td>0~60</td>
|
||||||
|
<td>m/s</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4106</td>
|
||||||
|
<td>pH</td>
|
||||||
|
<td>0~14</td>
|
||||||
|
<td>PH</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4107</td>
|
||||||
|
<td>Light Quantum</td>
|
||||||
|
<td>0~5000</td>
|
||||||
|
<td>umol/㎡s</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4108</td>
|
||||||
|
<td>Electrical Conductivity</td>
|
||||||
|
<td>0~23</td>
|
||||||
|
<td>dS/m</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4109</td>
|
||||||
|
<td>Dissolved Oxygen</td>
|
||||||
|
<td>0~20</td>
|
||||||
|
<td>mg/L</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4110</td>
|
||||||
|
<td>Soil Volumetric Water Content</td>
|
||||||
|
<td>0~100</td>
|
||||||
|
<td>%</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4111</td>
|
||||||
|
<td>Soil Electrical Conductivity</td>
|
||||||
|
<td>0~23</td>
|
||||||
|
<td>dS/m</td>
|
||||||
|
<td>Deprecated,please use 4108 instead</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4112</td>
|
||||||
|
<td>Soil Temperature(Soil Temperature, VWC & EC Sensor)</td>
|
||||||
|
<td>-40~60</td>
|
||||||
|
<td>℃</td>
|
||||||
|
<td>Deprecated,please use 4102 instead</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4113</td>
|
||||||
|
<td>Rainfall Hourly</td>
|
||||||
|
<td>0~240</td>
|
||||||
|
<td>mm/hour</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4115</td>
|
||||||
|
<td>Distance</td>
|
||||||
|
<td>28~250</td>
|
||||||
|
<td>cm</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4116</td>
|
||||||
|
<td>Water Leak</td>
|
||||||
|
<td>true / false</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4117</td>
|
||||||
|
<td>Liguid Level</td>
|
||||||
|
<td>0~500</td>
|
||||||
|
<td>cm</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4118</td>
|
||||||
|
<td>NH3</td>
|
||||||
|
<td>0~100</td>
|
||||||
|
<td>ppm</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4119</td>
|
||||||
|
<td>H2S</td>
|
||||||
|
<td>0~100</td>
|
||||||
|
<td>ppm</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4120</td>
|
||||||
|
<td>Flow Rate</td>
|
||||||
|
<td>0~65535</td>
|
||||||
|
<td>m3/h</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4121</td>
|
||||||
|
<td>Total Flow</td>
|
||||||
|
<td>0~6553599</td>
|
||||||
|
<td>m3</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4122</td>
|
||||||
|
<td>Oxygen Concentration</td>
|
||||||
|
<td>0~25</td>
|
||||||
|
<td>%vol</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4123</td>
|
||||||
|
<td>Water Eletrical Conductivity</td>
|
||||||
|
<td>0~20000</td>
|
||||||
|
<td>us/cm</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4124</td>
|
||||||
|
<td>Water Temperature</td>
|
||||||
|
<td>-40~80</td>
|
||||||
|
<td>℃</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4125</td>
|
||||||
|
<td>Soil Heat Flux</td>
|
||||||
|
<td>-500~500</td>
|
||||||
|
<td>W/㎡</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4126</td>
|
||||||
|
<td>Sunshine Duration</td>
|
||||||
|
<td>0~24</td>
|
||||||
|
<td>h</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4127</td>
|
||||||
|
<td>Total Solar Radiation</td>
|
||||||
|
<td>0~5000</td>
|
||||||
|
<td>W/㎡</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4128</td>
|
||||||
|
<td>Water Surface Evaporation</td>
|
||||||
|
<td>0~10000</td>
|
||||||
|
<td>mm</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4129</td>
|
||||||
|
<td>Photosynthetically Active Radiation(PAR)</td>
|
||||||
|
<td>0~5000</td>
|
||||||
|
<td>umol/㎡s</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4130</td>
|
||||||
|
<td>Accelerometer</td>
|
||||||
|
<td>0,0,0~x.xx,y.yy,z.zz</td>
|
||||||
|
<td>m/s</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4131</td>
|
||||||
|
<td>Sound Intensity</td>
|
||||||
|
<td>0~100</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4133</td>
|
||||||
|
<td>Soil Tension</td>
|
||||||
|
<td>-100~0</td>
|
||||||
|
<td>KPA</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4134</td>
|
||||||
|
<td>Salinity</td>
|
||||||
|
<td>0~20000</td>
|
||||||
|
<td>mg/L</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4135</td>
|
||||||
|
<td>TDS</td>
|
||||||
|
<td>0~20000</td>
|
||||||
|
<td>mg/L</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4136</td>
|
||||||
|
<td>Leaf Temperature</td>
|
||||||
|
<td>0~100</td>
|
||||||
|
<td>℃</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4137</td>
|
||||||
|
<td>Leaf Wetness</td>
|
||||||
|
<td>-40~85</td>
|
||||||
|
<td>%</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4138</td>
|
||||||
|
<td>Soil Moisture-10cm</td>
|
||||||
|
<td>0~100</td>
|
||||||
|
<td>%</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4139</td>
|
||||||
|
<td>Soil Moisture-20cm</td>
|
||||||
|
<td>0~100</td>
|
||||||
|
<td>%</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4140</td>
|
||||||
|
<td>Soil Moisture-30cm</td>
|
||||||
|
<td>0~100</td>
|
||||||
|
<td>%</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4141</td>
|
||||||
|
<td>Soil Moisture-40cm</td>
|
||||||
|
<td>0~100</td>
|
||||||
|
<td>%</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4142</td>
|
||||||
|
<td>Soil Temperature-10cm</td>
|
||||||
|
<td>-30~70</td>
|
||||||
|
<td>℃</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4143</td>
|
||||||
|
<td>Soil Temperature-20cm</td>
|
||||||
|
<td>-30~70</td>
|
||||||
|
<td>℃</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4144</td>
|
||||||
|
<td>Soil Temperature-30cm</td>
|
||||||
|
<td>-30~70</td>
|
||||||
|
<td>℃</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4145</td>
|
||||||
|
<td>Soil Temperature-40cm</td>
|
||||||
|
<td>-30~70</td>
|
||||||
|
<td>℃</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4146</td>
|
||||||
|
<td>PM2.5</td>
|
||||||
|
<td>0~1000</td>
|
||||||
|
<td>μg/m3</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4147</td>
|
||||||
|
<td>PM10</td>
|
||||||
|
<td>0~2000</td>
|
||||||
|
<td>μg/m3</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4148</td>
|
||||||
|
<td>Noise</td>
|
||||||
|
<td>30~130</td>
|
||||||
|
<td>dB</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4150</td>
|
||||||
|
<td>AccelerometerX</td>
|
||||||
|
<td>-49.99~49.99</td>
|
||||||
|
<td>m/s²</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4151</td>
|
||||||
|
<td>AccelerometerY</td>
|
||||||
|
<td>-49.99~49.99</td>
|
||||||
|
<td>m/s²</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4152</td>
|
||||||
|
<td>AccelerometerZ</td>
|
||||||
|
<td>-49.99~49.99</td>
|
||||||
|
<td>m/s²</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4157</td>
|
||||||
|
<td>Ammonia ion</td>
|
||||||
|
<td>0~100</td>
|
||||||
|
<td>mg/L</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4165</td>
|
||||||
|
<td>Measurement1</td>
|
||||||
|
<td>~</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4166</td>
|
||||||
|
<td>Measurement2</td>
|
||||||
|
<td>~</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4167</td>
|
||||||
|
<td>Measurement3</td>
|
||||||
|
<td>~</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4168</td>
|
||||||
|
<td>Measurement4</td>
|
||||||
|
<td>~</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4169</td>
|
||||||
|
<td>Measurement5</td>
|
||||||
|
<td>~</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4170</td>
|
||||||
|
<td>Measurement6</td>
|
||||||
|
<td>~</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4171</td>
|
||||||
|
<td>Measurement7</td>
|
||||||
|
<td>~</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4172</td>
|
||||||
|
<td>Measurement8</td>
|
||||||
|
<td>~</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4173</td>
|
||||||
|
<td>Measurement9</td>
|
||||||
|
<td>~</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4174</td>
|
||||||
|
<td>Measurement10</td>
|
||||||
|
<td>~</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4175</td>
|
||||||
|
<td>AI Detection No.01</td>
|
||||||
|
<td>1.00~39.99</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4176</td>
|
||||||
|
<td>AI Detection No.02</td>
|
||||||
|
<td>1.00~39.99</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4177</td>
|
||||||
|
<td>AI Detection No.03</td>
|
||||||
|
<td>1.00~39.99</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4178</td>
|
||||||
|
<td>AI Detection No.04</td>
|
||||||
|
<td>1.00~39.99</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4179</td>
|
||||||
|
<td>AI Detection No.05</td>
|
||||||
|
<td>1.00~39.99</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4180</td>
|
||||||
|
<td>AI Detection No.06</td>
|
||||||
|
<td>1.00~39.99</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4181</td>
|
||||||
|
<td>AI Detection No.07</td>
|
||||||
|
<td>1.00~39.99</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4182</td>
|
||||||
|
<td>AI Detection No.08</td>
|
||||||
|
<td>1.00~39.99</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4183</td>
|
||||||
|
<td>AI Detection No.09</td>
|
||||||
|
<td>1.00~39.99</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4184</td>
|
||||||
|
<td>AI Detection No.10</td>
|
||||||
|
<td>1.00~39.99</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4190</td>
|
||||||
|
<td>UV Index</td>
|
||||||
|
<td>0~16.0</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4191</td>
|
||||||
|
<td>Peak Wind Gust</td>
|
||||||
|
<td>0~100</td>
|
||||||
|
<td>m/s</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4192</td>
|
||||||
|
<td>Sound Intensity</td>
|
||||||
|
<td>0~1023</td>
|
||||||
|
<td>dB</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4193</td>
|
||||||
|
<td>Light Intensity</td>
|
||||||
|
<td>0~1023</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4195</td>
|
||||||
|
<td>TVOC</td>
|
||||||
|
<td>0~60000</td>
|
||||||
|
<td>ppb</td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4196</td>
|
||||||
|
<td>Soil moisture intensity</td>
|
||||||
|
<td>0~1023</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>5100</td>
|
||||||
|
<td>Switch</td>
|
||||||
|
<td>100~200</td>
|
||||||
|
<td></td>
|
||||||
|
<td></td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
507
docs/Cloud_Chain/SenseCAP_API/Appendix/List_of_Sensor_Types.md
Normal file
@ -0,0 +1,507 @@
|
|||||||
|
---
|
||||||
|
description: List_of_Sensor_Types
|
||||||
|
title: List of Sensor Types
|
||||||
|
keywords:
|
||||||
|
- Cloud and Chain
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
last_update:
|
||||||
|
date: 02/14/2023
|
||||||
|
author: Matthew
|
||||||
|
---
|
||||||
|
|
||||||
|
<div class="post-header">
|
||||||
|
<h1>List of Sensor Types</h1>
|
||||||
|
</div>
|
||||||
|
<div class="post-content">
|
||||||
|
<div>
|
||||||
|
<div id="di"></div>
|
||||||
|
<table id="tb" border="1">
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<th>Sensor ID</th>
|
||||||
|
<th>Sensor Name</th>
|
||||||
|
<th>Measurement IDs</th>
|
||||||
|
<th>Measurement Name</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>1001</td>
|
||||||
|
<td>Air Temperature and Humidity Sensor</td>
|
||||||
|
<td>4097,
|
||||||
|
4098</td>
|
||||||
|
<td>Air Temperature,
|
||||||
|
Air Humidity</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>1003</td>
|
||||||
|
<td>Light Intensity Sensor</td>
|
||||||
|
<td>4099</td>
|
||||||
|
<td>Light Intensity</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>1004</td>
|
||||||
|
<td>CO2 Sensor</td>
|
||||||
|
<td>4100</td>
|
||||||
|
<td>CO2</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>1005</td>
|
||||||
|
<td>Barometric Pressure Sensor</td>
|
||||||
|
<td>4101</td>
|
||||||
|
<td>Barometric Pressure</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>1006</td>
|
||||||
|
<td>Soil Moisture and Temperature Sensor</td>
|
||||||
|
<td>4102,
|
||||||
|
4103</td>
|
||||||
|
<td>Soil Temperature,
|
||||||
|
Soil Moisture</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>1008</td>
|
||||||
|
<td>Wind Direction Sensor</td>
|
||||||
|
<td>4104</td>
|
||||||
|
<td>Wind Direction</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>1009</td>
|
||||||
|
<td>Wind Speed Sensor</td>
|
||||||
|
<td>4105</td>
|
||||||
|
<td>Wind Speed</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>1011</td>
|
||||||
|
<td>Rain Gauge</td>
|
||||||
|
<td>4113</td>
|
||||||
|
<td>Rainfall Hourly</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>1013</td>
|
||||||
|
<td>Ultrasonic Distance Sensor</td>
|
||||||
|
<td>4115</td>
|
||||||
|
<td>Distance</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>1014</td>
|
||||||
|
<td>Water Leak Detector</td>
|
||||||
|
<td>4116</td>
|
||||||
|
<td>Water Leak</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>1015</td>
|
||||||
|
<td>Liguid Level Sensor</td>
|
||||||
|
<td>4117</td>
|
||||||
|
<td>Liguid Level</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>1016</td>
|
||||||
|
<td>CO2, Temperature and Humidity Sensor</td>
|
||||||
|
<td>4097,
|
||||||
|
4098,
|
||||||
|
4100</td>
|
||||||
|
<td>Air Temperature,
|
||||||
|
Air Humidity,
|
||||||
|
CO2</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2001</td>
|
||||||
|
<td>Compact Weather Station 5 in 1 (S500)</td>
|
||||||
|
<td>4097,
|
||||||
|
4098,
|
||||||
|
4101,
|
||||||
|
4104,
|
||||||
|
4105</td>
|
||||||
|
<td>Air Temperature,
|
||||||
|
Air Humidity,
|
||||||
|
Barometric Pressure,
|
||||||
|
Wind Direction,
|
||||||
|
Wind Speed</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2002</td>
|
||||||
|
<td>Compact Weather Station 3 in 1 (S300)</td>
|
||||||
|
<td>4097,
|
||||||
|
4098,
|
||||||
|
4101</td>
|
||||||
|
<td>Air Temperature,
|
||||||
|
Air Humidity,
|
||||||
|
Barometric Pressure</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2003</td>
|
||||||
|
<td>Compact Weather Station 4 in 1 (S400)</td>
|
||||||
|
<td>4097,
|
||||||
|
4098,
|
||||||
|
4101,
|
||||||
|
4099</td>
|
||||||
|
<td>Air Temperature,
|
||||||
|
Air Humidity,
|
||||||
|
Barometric Pressure,
|
||||||
|
Light Intensity</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2004</td>
|
||||||
|
<td>NH3, Temperature & Humidity Sensor</td>
|
||||||
|
<td>4097,
|
||||||
|
4098,
|
||||||
|
4118</td>
|
||||||
|
<td>Air Temperature,
|
||||||
|
Air Humidity,
|
||||||
|
NH3</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2005</td>
|
||||||
|
<td>H2S, Temperature & Humidity Sensor</td>
|
||||||
|
<td>4097,
|
||||||
|
4098,
|
||||||
|
4119</td>
|
||||||
|
<td>Air Temperature,
|
||||||
|
Air Humidity,
|
||||||
|
H2S</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2007</td>
|
||||||
|
<td>Soil Temperature and VWC Sensor</td>
|
||||||
|
<td>4110,
|
||||||
|
4102</td>
|
||||||
|
<td>Soil Volumetric Water Content,
|
||||||
|
Soil Temperature</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2009</td>
|
||||||
|
<td>Turbine Flowmeter Sensor</td>
|
||||||
|
<td>4120,
|
||||||
|
4121</td>
|
||||||
|
<td>Flow Rate,
|
||||||
|
Total Flow</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2010</td>
|
||||||
|
<td>Sunshine Duration Sensor</td>
|
||||||
|
<td>4126</td>
|
||||||
|
<td>Sunshine Duration</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2011</td>
|
||||||
|
<td>Total Solar Radiation Sensor</td>
|
||||||
|
<td>4127</td>
|
||||||
|
<td>Total Solar Radiation</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2012</td>
|
||||||
|
<td>Evaporation Sensor</td>
|
||||||
|
<td>4128</td>
|
||||||
|
<td>Water Surface Evaporation</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2013</td>
|
||||||
|
<td>PAR Sensor</td>
|
||||||
|
<td>4129</td>
|
||||||
|
<td>Photosynthetically Active Radiation(PAR)</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2015</td>
|
||||||
|
<td>Soil Heat Flux Sensor</td>
|
||||||
|
<td>4125</td>
|
||||||
|
<td>Soil Heat Flux</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2016</td>
|
||||||
|
<td>Soil Tension Meter</td>
|
||||||
|
<td>4133</td>
|
||||||
|
<td>Soil Tension</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2017</td>
|
||||||
|
<td>Liquid EC and TDS Sensor</td>
|
||||||
|
<td>4123,
|
||||||
|
4124,
|
||||||
|
4134,
|
||||||
|
4135</td>
|
||||||
|
<td>Water Eletrical Conductivity,
|
||||||
|
Water Temperature,
|
||||||
|
Salinity,
|
||||||
|
TDS</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2018</td>
|
||||||
|
<td>Leaf Wetness and Temperature Sensor</td>
|
||||||
|
<td>4137,
|
||||||
|
4136</td>
|
||||||
|
<td>Leaf Wetness,
|
||||||
|
Leaf Temperature</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2019</td>
|
||||||
|
<td>Multilayer Soil Moisture and Temperature Sensor</td>
|
||||||
|
<td>4145,
|
||||||
|
4144,
|
||||||
|
4143,
|
||||||
|
4142,
|
||||||
|
4141,
|
||||||
|
4140,
|
||||||
|
4139,
|
||||||
|
4138</td>
|
||||||
|
<td>Soil Temperature-40cm,
|
||||||
|
Soil Temperature-30cm,
|
||||||
|
Soil Temperature-20cm,
|
||||||
|
Soil Temperature-10cm,
|
||||||
|
Soil Moisture-40cm,
|
||||||
|
Soil Moisture-30cm,
|
||||||
|
Soil Moisture-20cm,
|
||||||
|
Soil Moisture-10cm</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2025</td>
|
||||||
|
<td>LoraWAN Datalogger S2100</td>
|
||||||
|
<td>4174,
|
||||||
|
4173,
|
||||||
|
4172,
|
||||||
|
4171,
|
||||||
|
4170,
|
||||||
|
4169,
|
||||||
|
4168,
|
||||||
|
4167,
|
||||||
|
4166,
|
||||||
|
4165</td>
|
||||||
|
<td>Measurement10,
|
||||||
|
Measurement9,
|
||||||
|
Measurement8,
|
||||||
|
Measurement7,
|
||||||
|
Measurement6,
|
||||||
|
Measurement5,
|
||||||
|
Measurement4,
|
||||||
|
Measurement3,
|
||||||
|
Measurement2,
|
||||||
|
Measurement1</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2026</td>
|
||||||
|
<td>LoraWAN Dev Kit</td>
|
||||||
|
<td>4195,
|
||||||
|
4100,
|
||||||
|
4103,
|
||||||
|
4150,
|
||||||
|
4151,
|
||||||
|
4152,
|
||||||
|
4175,
|
||||||
|
4176,
|
||||||
|
4177,
|
||||||
|
4178,
|
||||||
|
4179,
|
||||||
|
4180,
|
||||||
|
4181,
|
||||||
|
4182,
|
||||||
|
4183,
|
||||||
|
4184,
|
||||||
|
4192,
|
||||||
|
4193</td>
|
||||||
|
<td>TVOC,
|
||||||
|
CO2,
|
||||||
|
Soil Moisture,
|
||||||
|
AccelerometerX,
|
||||||
|
AccelerometerY,
|
||||||
|
AccelerometerZ,
|
||||||
|
AI Detection No.01,
|
||||||
|
AI Detection No.02,
|
||||||
|
AI Detection No.03,
|
||||||
|
AI Detection No.04,
|
||||||
|
AI Detection No.05,
|
||||||
|
AI Detection No.06,
|
||||||
|
AI Detection No.07,
|
||||||
|
AI Detection No.08,
|
||||||
|
AI Detection No.09,
|
||||||
|
AI Detection No.10,
|
||||||
|
Sound Intensity,
|
||||||
|
Light Intensity</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2035</td>
|
||||||
|
<td>Soil Moisture, Temperature and EC Sensor</td>
|
||||||
|
<td>4102,
|
||||||
|
4103,
|
||||||
|
4108</td>
|
||||||
|
<td>Soil Temperature,
|
||||||
|
Soil Moisture,
|
||||||
|
Electrical Conductivity</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2036</td>
|
||||||
|
<td>Vision AI</td>
|
||||||
|
<td>4184,
|
||||||
|
4183,
|
||||||
|
4182,
|
||||||
|
4181,
|
||||||
|
4180,
|
||||||
|
4179,
|
||||||
|
4178,
|
||||||
|
4177,
|
||||||
|
4176,
|
||||||
|
4175</td>
|
||||||
|
<td>AI Detection No.10,
|
||||||
|
AI Detection No.09,
|
||||||
|
AI Detection No.08,
|
||||||
|
AI Detection No.07,
|
||||||
|
AI Detection No.06,
|
||||||
|
AI Detection No.05,
|
||||||
|
AI Detection No.04,
|
||||||
|
AI Detection No.03,
|
||||||
|
AI Detection No.02,
|
||||||
|
AI Detection No.01</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2040</td>
|
||||||
|
<td>LoRaWAN 8-in-1 Compact Weather Station (S2120)</td>
|
||||||
|
<td>4190,
|
||||||
|
4097,
|
||||||
|
4098,
|
||||||
|
4099,
|
||||||
|
4101,
|
||||||
|
4104,
|
||||||
|
4105,
|
||||||
|
4113</td>
|
||||||
|
<td>UV Index,
|
||||||
|
Air Temperature,
|
||||||
|
Air Humidity,
|
||||||
|
Light Intensity,
|
||||||
|
Barometric Pressure,
|
||||||
|
Wind Direction,
|
||||||
|
Wind Speed,
|
||||||
|
Rainfall Hourly</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2041</td>
|
||||||
|
<td>Compact Weather Station 10 in 1 (S1000)</td>
|
||||||
|
<td>4097,
|
||||||
|
4098,
|
||||||
|
4099,
|
||||||
|
4100,
|
||||||
|
4101,
|
||||||
|
4104,
|
||||||
|
4105,
|
||||||
|
4113,
|
||||||
|
4146,
|
||||||
|
4147</td>
|
||||||
|
<td>Air Temperature,
|
||||||
|
Air Humidity,
|
||||||
|
Light Intensity,
|
||||||
|
CO2,
|
||||||
|
Barometric Pressure,
|
||||||
|
Wind Direction,
|
||||||
|
Wind Speed,
|
||||||
|
Rainfall Hourly,
|
||||||
|
PM2.5,
|
||||||
|
PM10</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2042</td>
|
||||||
|
<td>Wind Speed and Direction Sensor</td>
|
||||||
|
<td>4104,
|
||||||
|
4105</td>
|
||||||
|
<td>Wind Direction,
|
||||||
|
Wind Speed</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2043</td>
|
||||||
|
<td>pH Sensor(S2106)</td>
|
||||||
|
<td>4097,
|
||||||
|
4106</td>
|
||||||
|
<td>Air Temperature,
|
||||||
|
pH</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>100A</td>
|
||||||
|
<td>PH Sensor</td>
|
||||||
|
<td>4106</td>
|
||||||
|
<td>pH</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>100B</td>
|
||||||
|
<td>PAR Sensor</td>
|
||||||
|
<td>4107</td>
|
||||||
|
<td>Light Quantum</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>100C</td>
|
||||||
|
<td>EC Sensor</td>
|
||||||
|
<td>4108</td>
|
||||||
|
<td>Electrical Conductivity</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>100D</td>
|
||||||
|
<td>Dissolved Oxygen Sensor</td>
|
||||||
|
<td>4109</td>
|
||||||
|
<td>Dissolved Oxygen</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>100E</td>
|
||||||
|
<td>Soil Temperature, VWC & EC Sensor</td>
|
||||||
|
<td>4110,
|
||||||
|
4108,
|
||||||
|
4102</td>
|
||||||
|
<td>Soil Volumetric Water Content,
|
||||||
|
Electrical Conductivity,
|
||||||
|
Soil Temperature</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>200A</td>
|
||||||
|
<td>Compact Weather Station 7 in 1 (S700)</td>
|
||||||
|
<td>4097,
|
||||||
|
4098,
|
||||||
|
4099,
|
||||||
|
4101,
|
||||||
|
4104,
|
||||||
|
4105,
|
||||||
|
4113</td>
|
||||||
|
<td>Air Temperature,
|
||||||
|
Air Humidity,
|
||||||
|
Light Intensity,
|
||||||
|
Barometric Pressure,
|
||||||
|
Wind Direction,
|
||||||
|
Wind Speed,
|
||||||
|
Rainfall Hourly</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>200D</td>
|
||||||
|
<td>Oxygen Sensor</td>
|
||||||
|
<td>4122</td>
|
||||||
|
<td>Oxygen Concentration</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>200E</td>
|
||||||
|
<td>Water EC Sensor</td>
|
||||||
|
<td>4123</td>
|
||||||
|
<td>Water Eletrical Conductivity</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>201A</td>
|
||||||
|
<td>Compact Weather Station 9 in 1 (S900)</td>
|
||||||
|
<td>4147,
|
||||||
|
4146,
|
||||||
|
4097,
|
||||||
|
4098,
|
||||||
|
4099,
|
||||||
|
4101,
|
||||||
|
4104,
|
||||||
|
4105,
|
||||||
|
4113</td>
|
||||||
|
<td>PM10,
|
||||||
|
PM2.5,
|
||||||
|
Air Temperature,
|
||||||
|
Air Humidity,
|
||||||
|
Light Intensity,
|
||||||
|
Barometric Pressure,
|
||||||
|
Wind Direction,
|
||||||
|
Wind Speed,
|
||||||
|
Rainfall Hourly</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>201B</td>
|
||||||
|
<td>Noise sensor</td>
|
||||||
|
<td>4148</td>
|
||||||
|
<td>Noise</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
@ -0,0 +1,123 @@
|
|||||||
|
---
|
||||||
|
description: Data_OpenStream_API_Quickstart
|
||||||
|
title: Data OpenStream API Quickstart
|
||||||
|
keywords:
|
||||||
|
- Cloud and Chain
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
last_update:
|
||||||
|
date: 02/14/2023
|
||||||
|
author: Matthew
|
||||||
|
---
|
||||||
|
|
||||||
|
<div class="post-content">
|
||||||
|
<div class="summary">
|
||||||
|
|
||||||
|
This guide will walk you through how to subscribe your devices’ messages as well as how to send a command to a specific device, using Eclipse Mosquitto’s CLIs to subscribe or publish messages.
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<div id="toc"></div>
|
||||||
|
<h2 id="setup" class="clickable-header top-level-header">Setup</h2>
|
||||||
|
<i class="icon-arrow-up back-to-top"></i>
|
||||||
|
<ul>
|
||||||
|
<li>Install or <a href="https://mosquitto.org/download/">download</a> Mosquitto.</li>
|
||||||
|
</ul>
|
||||||
|
<h2 id="credentials" class="clickable-header top-level-header">Credentials</h2>
|
||||||
|
<i class="icon-arrow-up back-to-top"></i>Browse SenseCAP Portal, navigate to “Security/Access API keys”, click the “Create Access Key”, and you can get the “Access API keys”, set down it as <Password>, and also “Organization ID” as <OrgID>.
|
||||||
|
<figure><img class="docimage" src="https://sensecap-docs.seeed.cc/images/open_api/access_key_en.png" alt="" /></figure>
|
||||||
|
<figure><img class="docimage" src="https://sensecap-docs.seeed.cc/images/open_api/access_key_en_2.png" alt="" /></figure>
|
||||||
|
<figure><img class="docimage" src="https://sensecap-docs.seeed.cc/images/open_api/access_key_en_3.png" alt="" /></figure>
|
||||||
|
<h2 id="receive-devices-messages" class="clickable-header top-level-header">Receive Devices’ Messages</h2>
|
||||||
|
<i class="icon-arrow-up back-to-top"></i>Let’s listen for all of your devices’ messages.
|
||||||
|
|
||||||
|
1.Open a terminal window and execute the following command.
|
||||||
|
<ul>
|
||||||
|
<li>OrgID = Organization ID</li>
|
||||||
|
<li>Password = Access API keys</li>
|
||||||
|
</ul>
|
||||||
|
<div class="language-ruby highlighter-rouge">
|
||||||
|
<div class="highlight">
|
||||||
|
<pre class="highlight"><code><span class="n">mosquitto_sub</span> <span class="p">\</span>
|
||||||
|
<span class="o">-</span><span class="n">h</span> <span class="n">sensecap</span><span class="o">-</span><span class="n">openstream</span><span class="p">.</span><span class="nf">seeed</span><span class="p">.</span><span class="nf">cn</span> <span class="p">\</span>
|
||||||
|
<span class="o">-</span><span class="n">t</span> <span class="s1">'/device_sensor_data/<OrgID>/+/+/+/+'</span> <span class="p">\</span>
|
||||||
|
<span class="o">-</span><span class="n">u</span> <span class="s1">'org-<OrgID>'</span> <span class="p">\</span>
|
||||||
|
<span class="o">-</span><span class="no">P</span> <span class="s1">'<Password>'</span> <span class="p">\</span>
|
||||||
|
<span class="o">-</span><span class="no">I</span> <span class="s1">'org-<OrgID>-quickstart'</span> <span class="p">\</span>
|
||||||
|
<span class="o">-</span><span class="n">v</span>
|
||||||
|
</code></pre>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
Please replace the Organization ID and Access API Key you just obtained with the <OrgID> and <Password> above.
|
||||||
|
|
||||||
|
2.Power up devices, while devices keep sending messages, you should receive the data like:
|
||||||
|
<div className="language-ruby highlighter-rouge">
|
||||||
|
<div className="highlight">
|
||||||
|
<pre className="highlight"><code><span className="sr">/device_sensor_data/</span><span className="mi">1234</span><span className="o">/</span><span className="mi">2</span><span className="no">CF7F12000000001</span><span className="o">/</span><span className="mi">1</span><span className="o">/</span><span className="n">vs</span><span className="o">/</span><span className="mi">4105</span> <span className="p" /><span className="s2">"value"</span><span className="p">:</span><span className="mi">2</span><span className="p">,</span><span className="s2">"timestamp"</span><span className="p">:</span><span className="mi">1544151824139</span><span className="p" />{"\n"}<span className="sr">/device_sensor_data/xxxx</span><span className="o">/</span><span className="mi">2</span><span className="no">CF7F12XXXXXXXXX</span><span className="o">/</span><span className="mi">1</span><span className="o">/</span><span className="n">vs</span><span className="o">/</span><span className="mi">4097</span> <span className="p" /><span className="s2">"value"</span><span className="p">:</span><span className="mi">23</span><span className="p">,</span><span className="s2">"timestamp"</span><span className="p">:</span><span className="mi">1544151900992</span><span className="p" />{"\n"}<span className="sr">/device_sensor_data/xxxx</span><span className="o">/</span><span className="mi">2</span><span className="no">CF7F12XXXXXXXXX</span><span className="o">/</span><span className="mi">1</span><span className="o">/</span><span className="n">vs</span><span className="o">/</span><span className="mi">4101</span> <span className="p" /><span className="s2">"value"</span><span className="p">:</span><span className="mi">101629</span><span className="p">,</span><span className="s2">"timestamp"</span><span className="p">:</span><span className="mi">1544151901112</span><span className="p" />{"\n"}<span className="sr">/device_sensor_data/xxxx</span><span className="o">/</span><span className="mi">2</span><span className="no">CF7F12XXXXXXXXX</span><span className="o">/</span><span className="mi">1</span><span className="o">/</span><span className="n">vs</span><span className="o">/</span><span className="mi">4098</span> <span className="p" /><span className="s2">"value"</span><span className="p">:</span><span className="mi">71</span><span className="p">,</span><span className="s2">"timestamp"</span><span className="p">:</span><span className="mi">1544151900992</span><span className="p" />{"\n"}<span className="sr">/device_sensor_data/xxxx</span><span className="o">/</span><span className="mi">2</span><span className="no">CF7F12XXXXXXXXX</span><span className="o">/</span><span className="mi">1</span><span className="o">/</span><span className="n">vs</span><span className="o">/</span><span className="mi">4099</span> <span className="p" /><span className="s2">"value"</span><span className="p">:</span><span className="mf">69.12</span><span className="p">,</span><span className="s2">"timestamp"</span><span className="p">:</span><span className="mi">1544151902224</span><span className="p" />{"\n"}<span className="sr">/device_sensor_data/xxxx</span><span className="o">/</span><span className="mi">2</span><span className="no">CF7F12XXXXXXXXX</span><span className="o">/</span><span className="mi">1</span><span className="o">/</span><span className="n">vs</span><span className="o">/</span><span className="mi">4100</span> <span className="p" /><span className="s2">"value"</span><span className="p">:</span><span className="mi">437</span><span className="p">,</span><span className="s2">"timestamp"</span><span className="p">:</span><span className="mi">1544151922137</span><span className="p" />{"\n"}</code></pre>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>example</th>
|
||||||
|
<th>field</th>
|
||||||
|
<th>description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td>1234</td>
|
||||||
|
<td>OrgId</td>
|
||||||
|
<td>Organization ID</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2CF7F12000000001</td>
|
||||||
|
<td>DeviceEUI</td>
|
||||||
|
<td>Unique identification of device</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>1</td>
|
||||||
|
<td>Channel</td>
|
||||||
|
<td>A physical socket on the device for a sensor to be connected</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>vs</td>
|
||||||
|
<td>Reserved</td>
|
||||||
|
<td>The reserved field</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>4105</td>
|
||||||
|
<td>MeasureID</td>
|
||||||
|
<td>The type of measurement, 4105 is the Wind Speed</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>2</td>
|
||||||
|
<td>value</td>
|
||||||
|
<td>Collected measurements, the Wind Speed is 2m/s</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>1544151824139</td>
|
||||||
|
<td>timestamp</td>
|
||||||
|
<td>The collection timestamp of the data</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h2 id="subscribe-a-specific-key" class="clickable-header top-level-header">Subscribe a Specific Key</h2>
|
||||||
|
<i class="icon-arrow-up back-to-top"></i>Specifying a specific key enables you to subscribe to data for a particular device or channel.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
Subscribe to the temperature value collected by the Air Temperature and Humidity Sensor (DeviceEUI: 2CF7F12210400083;Channel: 1;).The temperature measurement ID is 4097.
|
||||||
|
Replace <OrgID> as Organization ID, <Password> as Access API Key, execute the command:
|
||||||
|
<div className="language-ruby highlighter-rouge">
|
||||||
|
<div className="highlight">
|
||||||
|
<pre className="highlight"><code><span className="n">mosquitto_sub</span> <span className="p">\</span>{"\n"}{" "}<span className="o">-</span><span className="n">h</span> <span className="n">sensecap</span><span className="o">-</span><span className="n">openstream</span><span className="p">.</span><span className="nf">seeed</span><span className="p">.</span><span className="nf">cn</span> <span className="p">\</span>{"\n"}{" "}<span className="o">-</span><span className="n">t</span> <span className="s1">'/device_sensor_data/<OrgID>/2CF7F12210400083/1/vs/4097'</span> <span className="p">\</span>{"\n"}{" "}<span className="o">-</span><span className="n">u</span> <span className="s1">'org-<OrgID>'</span> <span className="p">\</span>{"\n"}{" "}<span className="o">-</span><span className="no">P</span> <span className="s1">'<Password>'</span> <span className="p">\</span>{"\n"}{" "}<span className="o">-</span><span className="no">I</span> <span className="s1">'org-<OrgID>-quickstart'</span> <span className="p">\</span>{"\n"}{" "}<span className="o">-</span><span className="n">v</span>{"\n"}</code></pre>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
Received the data:
|
||||||
|
```cpp
|
||||||
|
/device_sensor_data/521853156991/2CF7F12210400083/1/vs/4097 {"value":28,"timestamp":1561373812474}
|
||||||
|
```
|
||||||
|
Congratulations! Now you know how to monitor and receive messages via MQTT. Go build something awesome!
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
@ -0,0 +1,153 @@
|
|||||||
|
---
|
||||||
|
description: Data_OpenStream_API_Quickstart
|
||||||
|
title: Data OpenStream API Reference
|
||||||
|
keywords:
|
||||||
|
- Cloud and Chain
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
last_update:
|
||||||
|
date: 02/14/2023
|
||||||
|
author: Matthew
|
||||||
|
---
|
||||||
|
|
||||||
|
<div class="post-content">
|
||||||
|
<div id="toc">
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
</div>
|
||||||
|
<h2 id="the-connection-information" class="clickable-header top-level-header">The Connection Information</h2>
|
||||||
|
<i class="icon-arrow-up back-to-top"></i>
|
||||||
|
<ul>
|
||||||
|
<li>Host: China Station: sensecap-openstream.seeed.cn Global Station: sensecap-openstream.seeed.cc</li>
|
||||||
|
<li>Port: 1883 for MQTT, or 8083 for MQTT Over WebSocket</li>
|
||||||
|
<li>ClientID: org-<Organization ID>-<Random ID>, replace <Orgnization ID> with you got from SenseCAP Portal, and replace <Random ID> with you randomly generated Numbers and lowercase letters.</li>
|
||||||
|
<li>Username: org-<Organization ID>, replace <Organization ID> with you got from dashboard (refer to the quickstart).</li>
|
||||||
|
<li>Password: Get Access API keys on your SenseCAP Portal “security /API Access Key” (refer to the quickstart).</li>
|
||||||
|
</ul>
|
||||||
|
<h2 id="publish-and-subscribe-model" class="clickable-header top-level-header">Publish And Subscribe Model</h2>
|
||||||
|
<i class="icon-arrow-up back-to-top"></i>SenseCAP OpenStream API implements “Publish And Subscribe Model”, as the MQTT protocol does. You can connect your server to SenseCAP OpenStream API through MQTT or MQTT Over WebSocket to communicate with the standard pub-sub protocol.
|
||||||
|
|
||||||
|
You can “subscribe” to receive messages. “subscribe” is the most common way to continuously monitor the telemetry data from devices.
|
||||||
|
<h2 id="message-topic" class="clickable-header top-level-header">Message Topic</h2>
|
||||||
|
<i class="icon-arrow-up back-to-top"></i>
|
||||||
|
<h3 id="receive-devices-telemeasuring-data">Receive Device’s Telemeasuring Data</h3>
|
||||||
|
Topic Format: /device_sensor_data/<OrgID>/<DeviceEUI>/<Channel>/<Reserved>/<MeasurementID>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Field</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td>OrgID</td>
|
||||||
|
<td>Your “Organization ID”, you can find this on SenseCAP Portal. You own a unique Organization ID, and all the topics will need it.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>DeviceEUI</td>
|
||||||
|
<td>Unique identification of device</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>Channel</td>
|
||||||
|
<td>A physical socket on the device for a sensor to be connected</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>Reserved</td>
|
||||||
|
<td>Reserved</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>MeasurementID</td>
|
||||||
|
<td>Please refer to “List of Measurement IDs” in this documentation</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<div class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note:</b> “+” means that there is no filtering condition for this field, matching all possible configurations. So, “/+/+/+/+” means to listen for all “<DeviceEUI>”, “<Channel>”, “<SensorEUI>”, “<MeasurementID>”</div>
|
||||||
|
Topic can specify filtering conditions to implement listening on specified devices, channels and measurement types. For example, you can only listen for Device whose device ID is “2F000000000000”, then you can replace the <DeviceEUI> field with 2F000000000000.
|
||||||
|
|
||||||
|
The “2F000000000000” in this example must be a device that you have already bound to your account. And you should always remember to replace <OrgID> with your own “Organization ID”.
|
||||||
|
<h4 id="message-body">Message Body</h4>
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
"value": "437",
|
||||||
|
"timestamp": "1544151922137"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This is a sensor measurement data uploaded by a device, which conforms to the JSON format and can be parsed by JSON parser. In general, for most functional requirements, a body needs to be used in conjunction with some fields in the topic.
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Field</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td>value</td>
|
||||||
|
<td>Sensor’s Measurement Value</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>timestamp</td>
|
||||||
|
<td>The collection timestamp of the data, unit millisecond</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
<h3 id="receive-devices-status-data">Receive Device’s Status Data</h3>
|
||||||
|
Topic Format: /device_status_event/<OrgID>/<DeviceEUI>/<Reserved>/<StatusID>
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Field</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td>OrgID</td>
|
||||||
|
<td>Your “Organization ID”, you can find this on SenseCAP Portal. You own a unique Organization ID, and all the topics will need it.</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>DeviceEUI</td>
|
||||||
|
<td>Unique identification of device</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>Reserved</td>
|
||||||
|
<td>Reserved</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>StatusID</td>
|
||||||
|
<td>Please refer to “List of Device Status IDs” in this documentation</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
Subscribe to the required StatusID according to the list of device state IDs to avoid subscribing to unexpected IDs
|
||||||
|
<h4 id="message-body-1">Message Body</h4>
|
||||||
|
|
||||||
|
```
|
||||||
|
{
|
||||||
|
"value": "437",
|
||||||
|
"timestamp": "1544151922137"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Field</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td>value</td>
|
||||||
|
<td>Sensor’s Status Value</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td>timestamp</td>
|
||||||
|
<td>The collection timestamp of the data, unit millisecond</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
109
docs/Cloud_Chain/SenseCAP_API/HTTP_API/HTTP_API_Access_Guide.md
Normal file
@ -0,0 +1,109 @@
|
|||||||
|
---
|
||||||
|
description: HTTP API Access Guide
|
||||||
|
title: HTTP API Access Guide
|
||||||
|
keywords:
|
||||||
|
- HTTP API
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
last_update:
|
||||||
|
date: 1/13/2023
|
||||||
|
author: shuxu hu
|
||||||
|
---
|
||||||
|
|
||||||
|
## HTTP Request and Response
|
||||||
|
|
||||||
|
Requests are authenticated with the HTTP Basic Authentication.
|
||||||
|
|
||||||
|
### HTTP HOST
|
||||||
|
|
||||||
|
- China Station: https://sensecap.seeed.cn/openapi
|
||||||
|
- Global Station: https://sensecap.seeed.cc/openapi
|
||||||
|
|
||||||
|
|
||||||
|
### HTTP HEADER
|
||||||
|
#### Request
|
||||||
|
<table >
|
||||||
|
<tr>
|
||||||
|
<th> key
|
||||||
|
</th>
|
||||||
|
<th> description
|
||||||
|
</th></tr>
|
||||||
|
<tr>
|
||||||
|
<td width="300"> API-VERSION
|
||||||
|
</td>
|
||||||
|
<td width="300"> api version
|
||||||
|
</td></tr></table>
|
||||||
|
|
||||||
|
#### Response
|
||||||
|
<table >
|
||||||
|
<tr>
|
||||||
|
<th> key
|
||||||
|
</th>
|
||||||
|
<th> description
|
||||||
|
</th></tr>
|
||||||
|
<tr>
|
||||||
|
<td width="300"> api-gateway-excute-second
|
||||||
|
</td>
|
||||||
|
<td width="300"> Time in seconds to execute the api
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td width="300"> api-gateway-mpuo-consume
|
||||||
|
</td>
|
||||||
|
<td width="300"> The quota consumed by executing the api
|
||||||
|
</td></tr></table>
|
||||||
|
|
||||||
|
#### HTTP Basic Authentication
|
||||||
|
[HTTP Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication)is one of the most common ways for RESTfull API authentication. We use Access ID as username and Access Key as password. Every HTTP client library should have its built-in support for Basic Authentication, in this documentation we use curl, which uses the –user option to specify Basic Authentication credential.
|
||||||
|
|
||||||
|
you can create access keys via SenseCAP Portal. Please refer to quickstart to see how to get an access key.
|
||||||
|
|
||||||
|
#### API Response
|
||||||
|
All response key follow the lowercase and underscore convention.
|
||||||
|
|
||||||
|
#### Successful Response with String
|
||||||
|
```cpp
|
||||||
|
{
|
||||||
|
"code":"0",
|
||||||
|
"data":"
|
||||||
|
// string
|
||||||
|
"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
#### Successful Response with Object
|
||||||
|
```cpp
|
||||||
|
{
|
||||||
|
"code":"0",
|
||||||
|
"data":{
|
||||||
|
// object
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
#### Successful response with Array
|
||||||
|
```cpp
|
||||||
|
{
|
||||||
|
"code":"0",
|
||||||
|
"data":[
|
||||||
|
// Array
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
#### Error Response
|
||||||
|
```cpp
|
||||||
|
{
|
||||||
|
"code":"1001",
|
||||||
|
"msg":"error message"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
## Tech Support & Product Discussion
|
||||||
|
|
||||||
|
Thank you for choosing our products! We are here to provide you with different support to ensure that your experience with our products is as smooth as possible. We offer several communication channels to cater to different preferences and needs.
|
||||||
|
|
||||||
|
<div class="button_tech_support_container">
|
||||||
|
<a href="https://forum.seeedstudio.com/" class="button_forum"></a>
|
||||||
|
<a href="https://www.seeedstudio.com/contacts" class="button_email"></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="button_tech_support_container">
|
||||||
|
<a href="https://discord.gg/eWkprNDMU7" class="button_discord"></a>
|
||||||
|
<a href="https://github.com/Seeed-Studio/wiki-documents/discussions/69" class="button_discussion"></a>
|
||||||
|
</div>
|
||||||
76
docs/Cloud_Chain/SenseCAP_API/HTTP_API/Quick_Start.md
Normal file
@ -0,0 +1,76 @@
|
|||||||
|
---
|
||||||
|
description: HTTP API Quickstart
|
||||||
|
title: HTTP API Quickstart
|
||||||
|
keywords:
|
||||||
|
- HTTP API
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
last_update:
|
||||||
|
date: 1/13/2023
|
||||||
|
author: shuxu hu
|
||||||
|
---
|
||||||
|
|
||||||
|
## Prerequisite
|
||||||
|
if you do not have an account, please register for the SenseCAP Portal.
|
||||||
|
- [China Station](https://sensecap.seeed.cn)
|
||||||
|
- [China Station](https://sensecap.seeed.cc)
|
||||||
|
|
||||||
|
:::note
|
||||||
|
LoRaWAN devices are used with Global Station
|
||||||
|
:::
|
||||||
|
|
||||||
|
## Get an Access Key
|
||||||
|
|
||||||
|
1. Login the SenseCAP Portal.
|
||||||
|
2. Navigate to “Security/Access API keys”
|
||||||
|
3. Click “Create Access Key”
|
||||||
|
4. Click “API ID”, and get the “API ID” and “Access API keys” after entering the password.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
## Get all the Device Groups
|
||||||
|
Use curl to make an HTTP request.The following example calls the API to get all the Device Groups under the account.
|
||||||
|
|
||||||
|
- username = API ID
|
||||||
|
- password = Access API keys
|
||||||
|
|
||||||
|
curl --user "username":"password" \
|
||||||
|
https://sensecap.seeed.cc/openapi/list_groups
|
||||||
|
|
||||||
|
You should replace and with the one you got before. The command will output like the following
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
{
|
||||||
|
"code": "0",
|
||||||
|
"data": [
|
||||||
|
{
|
||||||
|
"group_name": "Default",
|
||||||
|
"group_uuid": ""
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"group_name": "test group",
|
||||||
|
"group_uuid": "80523B280630E611"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"group_name": "demo",
|
||||||
|
"group_uuid": "EBAD5387C4FC8711"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Tech Support & Product Discussion
|
||||||
|
|
||||||
|
Thank you for choosing our products! We are here to provide you with different support to ensure that your experience with our products is as smooth as possible. We offer several communication channels to cater to different preferences and needs.
|
||||||
|
|
||||||
|
<div class="button_tech_support_container">
|
||||||
|
<a href="https://forum.seeedstudio.com/" class="button_forum"></a>
|
||||||
|
<a href="https://www.seeedstudio.com/contacts" class="button_email"></a>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="button_tech_support_container">
|
||||||
|
<a href="https://discord.gg/eWkprNDMU7" class="button_discord"></a>
|
||||||
|
<a href="https://github.com/Seeed-Studio/wiki-documents/discussions/69" class="button_discussion"></a>
|
||||||
|
</div>
|
||||||
23
docs/Cloud_Chain/SenseCAP_API/SenseCAP_API_Introduction.md
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
---
|
||||||
|
description: SenseCAP API Introduction
|
||||||
|
title: SenseCAP API Introduction
|
||||||
|
keywords:
|
||||||
|
- Cloud and Chain
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
last_update:
|
||||||
|
date: 02/14/2023
|
||||||
|
author: Matthew
|
||||||
|
---
|
||||||
|
|
||||||
|
# SenseCAP API Introduction
|
||||||
|
|
||||||
|
|
||||||
|
=============================
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
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.
|
||||||
126
docs/Cloud_Chain/SenseCAP_Dashboard/Dashboard_Basics.md
Normal file
@ -0,0 +1,126 @@
|
|||||||
|
---
|
||||||
|
description: Dashboard Basics
|
||||||
|
title: Dashboard Basics
|
||||||
|
keywords:
|
||||||
|
- Cloud and Chain
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
last_update:
|
||||||
|
date: 02/14/2023
|
||||||
|
author: Matthew
|
||||||
|
---
|
||||||
|
|
||||||
|
# Dashboard Basics
|
||||||
|
|
||||||
|
|
||||||
|
**Main Dashboard Screen**
|
||||||
|
=========================
|
||||||
|
|
||||||
|
Once you’ve registered your hotspot to the dashboard, you will find the following (see screenshot below).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
You will quickly be able to see all status updates of the hotspot on this page. If you register more than 1 hotspot, they will be added as separate rows.
|
||||||
|
|
||||||
|
Simply click the hotspot name or SN to view further details explained below.
|
||||||
|
|
||||||
|
* * *
|
||||||
|
|
||||||
|
**What Information You Can Find**
|
||||||
|
=================================
|
||||||
|
|
||||||
|
The dashboard allows you to monitor your hotspots settings, including **CPU temperature, network settings**, **blockchain syncing progress, and much more**. Below is a breakdown of what each setting represents.
|
||||||
|
|
||||||
|
**Note**: The information presented inside the dashboard is updated every 5 minutes. If you update network configuration changes, refreshing the dashboard in 5 minutes will provide updated data.
|
||||||
|
|
||||||
|
**Hotspot Details**
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
* **SN**: Your registered hotspot serial number.
|
||||||
|
* **Hotspot Name**: Name of your registered hotspot on the blockchain.
|
||||||
|
* **Hotspot Online** Status: Based on your hotspot.
|
||||||
|
* **Helium Online** Status: Hotspot status is strictly based on helium API or ETL-API, depending on which P2P data is up-to-date.
|
||||||
|
* **Hotspot Address**: The blockchain address of your hotspot. You can click the hotspot address to view your hotspot on the Helium Explorer website.
|
||||||
|
* **Hotspot Owner**: Your wallet (whom the hotspot is registered to on the ‘Helium App’) You can click the hotspot owner to view details of your entire account on the Helium Explorer website.
|
||||||
|
* **Public IP Address:** Your Hotspots public IP address.
|
||||||
|
|
||||||
|
**Additional Hotspot Details Continued**
|
||||||
|
----------------------------------------
|
||||||
|
|
||||||
|
* **Collection Time**: Last the data was collected from the hotspot. -UTC7.
|
||||||
|
* **Added to Helium Network**: Displays when the hotspot was registered on the Helium blockchain. -UTC7.
|
||||||
|
* **Production Time**: Displays when the hotspot was manufactured. -UTC7.
|
||||||
|
|
||||||
|
**Antenna & Region Details**
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
* **Antenna**: The gain of antenna data is from Helium APP. If you've changed the antenna, you will need to complete the "Update Antenna" process in the Helium APP to show the correct gain here.
|
||||||
|
* **Region**: This region is based on the asserted location of the hotspot in the Helium APP.
|
||||||
|
* You may not see a "**Region**" until you assert a location, it may result in "Unknown".
|
||||||
|
* **Coordinates**: Displays the GPS coordinates of your Hotspots asserted location.
|
||||||
|
|
||||||
|
**Additional Details**
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
* **Batch Name**: Manufactured date of the hotspot.
|
||||||
|
* **Custom Tag**: Any custom tag you've associated with this Hotspot.
|
||||||
|
* If you are running multiple hotspots in different locations, we’ve made it easier for you to tag each hotspot and sort by tags within the dashboard. Simply add a custom tag to differentiate hotspots between different locations/hosts.
|
||||||
|
|
||||||
|
**Additional Network Details**
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
* **Wi-fi Name**: If the hotspot is connected via Wi-Fi, it will display the Wi-Fi name here, if it is connected via Ethernet cable, it will not display anything.
|
||||||
|
* **Wi-Fi IP Address**: If your Hotspot is connected with Wi-Fi, you will see your internal network's IP address here.
|
||||||
|
* **LAN IP Address**: If your Hotspot is connected with an Ethernet cable, you will see your internal network address here.
|
||||||
|
|
||||||
|
**Hotspot Hardware Details**
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
* **Firmware Version**: Current firmware version installed on your Hotspot.
|
||||||
|
* **Uptime**: Uptime indicates the duration time started from last power-on time of the hotspot, which will be updated when there is internet connection. If we cannot detect a status within 30 mins, the uptime would show **NONE**.
|
||||||
|
* **CPU ID:** The CPU ID # of your hotspots CPU.
|
||||||
|
* The CPU ID will be required to enter when you wish to **TurboSync** your device. You may click the icon to the right of the CPU ID to copy.
|
||||||
|
* **CPU Temperature**: Current running temperature of your CPU.
|
||||||
|
* **Fan Status**: Displays if the fan is running with date + timestamp of the last status when it was ON or OFF.
|
||||||
|
* The fan will automatically turn on when the CPU temperature is above 70℃, and will not turn off until it is cooled down to 45℃.
|
||||||
|
* **CPU Usage**: Displays the current usage of the CPU in % units.
|
||||||
|
* **Memory Usage**: Displays the current memory usage in % units.
|
||||||
|
* **Note**: Depending on the model you purchase, you may see different memory details.
|
||||||
|
* 1900 MB = 2GB Raspberry Pi
|
||||||
|
* 3845 MB = 4GB Raspberry Pi
|
||||||
|
* 7690 MB = 8GB Raspberry Pi
|
||||||
|
* **SD Usage**: Displays the current SD Card memory usage.
|
||||||
|
* 58776 MB = 64GB SD card
|
||||||
|
|
||||||
|
**Hotspot Reward Details**
|
||||||
|
--------------------------
|
||||||
|
|
||||||
|
**Hotspot Rewards**: Displays your HNT rewards.
|
||||||
|
|
||||||
|
* **Last 24H**: What your last 24-hour reward was (rolling 24H window).
|
||||||
|
* **Last 7D**: What your last 7-day reward was (rolling 7D window).
|
||||||
|
* **Last 30D:** What your last 30-day reward was (rolling 30D window).
|
||||||
|
* **Total**: Displays total HNT rewarded since online.
|
||||||
|
|
||||||
|
There is a complex mechanism for the rewards. As long as the network settings, hotspot placement, antenna, internet connection and hotspot status are in good standing/healthy, the device will perform accordingly. The Helium Doc is always a great place to learn more on the rewards mechanism. >>[**https://docs.helium.com/blockchain/**](https://docs.helium.com/blockchain/mining)
|
||||||
|
|
||||||
|
**Useful Links Details**
|
||||||
|
------------------------
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
* **Doc Center**: >> Link to SenseCAP Document/Support Center
|
||||||
|
* **Port Checker**: Link to >> PortChecker.co to determine if your PORT is open.
|
||||||
|
* **Find IP Address**: Link to WhatIsMyIPAddress.com to display your current IP.
|
||||||
|
|
||||||
|
**Account Details**
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
After you log-in to your dashboard, you should be presented with a navigation pane on the left side as follows.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
* **Dashboard**: Dashboard home page.
|
||||||
|
* **Hotspot**: List’s all your hotspots that are registered.
|
||||||
|
* **Account**: Account management page, including API credentials, password resets, etc.
|
||||||
|
|
||||||
|
|
||||||
@ -0,0 +1,38 @@
|
|||||||
|
---
|
||||||
|
description: Dashboard Registration
|
||||||
|
title: Dashboard Registration
|
||||||
|
keywords:
|
||||||
|
- Cloud and Chain
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
last_update:
|
||||||
|
date: 02/14/2023
|
||||||
|
author: Matthew
|
||||||
|
---
|
||||||
|
|
||||||
|
# Dashboard Registration
|
||||||
|
|
||||||
|
|
||||||
|
The SenseCAP M1 dashboard is designed to help you monitor your Hotspot and give you a comprehensive overview.
|
||||||
|
|
||||||
|
**Dashboard Registration**
|
||||||
|
==========================
|
||||||
|
|
||||||
|
1. Visit [**https://status.sensecapmx.cloud/**](https://status.sensecapmx.cloud/)
|
||||||
|
2. Click the "**Register**" button below.
|
||||||
|
1. You will have the option to create an account OR register/login with your Discord Account.
|
||||||
|
3. Enter the details required to begin creating your account.
|
||||||
|
4. After filling in your "**Email Address**", you will need to click "**Get Captcha**".
|
||||||
|
1. The system will send a “**one-time code**” to the registered email you provided to validate ownership of that email account.
|
||||||
|
2. You will have **60 seconds** to retrieve the code from your inbox.
|
||||||
|
5. Once you enter the "**one-time code**" please click "**Register**" and you will be successfully registered to monitor your hotspot remotely.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
**Dashboard Login**
|
||||||
|
===================
|
||||||
|
|
||||||
|
1. Visit [**https://status.sensecapmx.cloud/**](https://status.sensecapmx.cloud/)
|
||||||
|
2. Enter the credentials you created during the registration process OR login with your Discount account details (whichever you've selected during the registration process)
|
||||||
|
3. Congratulations, you've successfully logged in.
|
||||||
|
|
||||||
|

|
||||||
65
docs/Cloud_Chain/SenseCAP_Dashboard/Hotspot_Registration.md
Normal file
@ -0,0 +1,65 @@
|
|||||||
|
---
|
||||||
|
description: Hotspot Registration
|
||||||
|
title: Hotspot Registration
|
||||||
|
keywords:
|
||||||
|
- Cloud and Chain
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
last_update:
|
||||||
|
date: 02/14/2023
|
||||||
|
author: Matthew
|
||||||
|
---
|
||||||
|
|
||||||
|
# Hotspot Registration
|
||||||
|
|
||||||
|
**How To Register Hotspots With Helium Wallet**
|
||||||
|
===============================================
|
||||||
|
|
||||||
|
* Please login to the SenseCAP Dashboard by visiting [**https://status.sensecapmx.cloud/**](https://status.sensecapmx.cloud/)
|
||||||
|
* Ensure your "Helium APP" is the latest version and login to your Helium wallet.
|
||||||
|
|
||||||
|
You can download the latest version by visiting the [**Android Store**](https://play.google.com/store/apps/details?id=com.helium.wallet&hl=en_US) or the [**iOS Store**](https://apps.apple.com/app/id1450463605).
|
||||||
|
|
||||||
|
* On the SenseCAP Dashboard, click "Hotspot" on the left menu, then click the blue button that reads "+ Add New Hotspot".
|
||||||
|
|
||||||
|
You will then be prompted with a QR code to import your Hotspot from the Helium Wallet as below:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Use "Helium App" to scan the QR code shown in Dashboard.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Scan the QR code with your Helium Wallet and grant permission in "**Helium App**" when you are prompted to link wallets.
|
||||||
|
|
||||||
|
**Note**: This does NOT give anyone access to your seed phrase to your wallet, this only allows the dashboard to connect and add your hotspot(s) to the dashboard.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Select and add the Hotspot(s) you wish to add to the SenseCAP Dashboard and click the button.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
If your wallet was successfully linked, you will see the message below. **You are all set!**
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
**Register Hotspots With Device Information**
|
||||||
|
=============================================
|
||||||
|
|
||||||
|
**Note**: Your could register your hotspot to the dashboard with either your Helium Wallet or your device information. If you choose to register the hotspot with the device information, you will need to login to your hotspot's Local Console to get the device information.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
* Log-in to the dashboard ⇒ [**https://status.sensecapmx.cloud/**](https://status.sensecapmx.cloud/)
|
||||||
|
* Enter the credentials you created during registration and log in
|
||||||
|
* Navigate to “Hotspot” on the left menu column
|
||||||
|
* Click "Add new Hotspot"
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
* You will be prompted to enter the "**SN", "ETH MAC**" address, "**CPU ID**" and "**bind key**", which "**SN**" is located on the bottom label of your SenseCAP M1, and others are in the Local Console Page.
|
||||||
|
* Click “**Confirm**” and the Hotspot will now be added to your dashboard.
|
||||||
|
|
||||||
|
**Note**: The CPU ID usually begins with 1 followd by 7 zero’s. ie., _**10000000**_
|
||||||
|
|
||||||
|
**Congratulations**! You've successfully added your Hotspot to the dashboard to begin monitoring. You may repeat these steps for additional hotspot to monitor.
|
||||||
17
docs/Cloud_Chain/SenseCAP_Hotspot_APP/APP_settings.md
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
---
|
||||||
|
description: APP Settings
|
||||||
|
title: Settings
|
||||||
|
keywords:
|
||||||
|
- Cloud and Chain
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
last_update:
|
||||||
|
date: 02/14/2023
|
||||||
|
author: Matthew
|
||||||
|
---
|
||||||
|
|
||||||
|
# APP Settings
|
||||||
|
|
||||||
|
|
||||||
|
In Settings, SenseCAP App allows you to enable PIN, get the support documents, open a support ticket on Help Center, switch helium wallet, or exit helium wallet.
|
||||||
|
|
||||||
|

|
||||||
@ -0,0 +1,30 @@
|
|||||||
|
---
|
||||||
|
description: Deeplink Helium Wallet
|
||||||
|
title: Deeplink Helium Wallet
|
||||||
|
keywords:
|
||||||
|
- Cloud and Chain
|
||||||
|
image: https://files.seeedstudio.com/wiki/wiki-platform/S-tempor.png
|
||||||
|
last_update:
|
||||||
|
date: 02/14/2023
|
||||||
|
author: Matthew
|
||||||
|
---
|
||||||
|
|
||||||
|
**Deeplink Helium Wallet**
|
||||||
|
==========================
|
||||||
|
|
||||||
|
SenseCAP Hotspot App offers two ways to add a user's wallet without requiring the user to enter the wallet's 12 seed words.
|
||||||
|
|
||||||
|
* If you have downloaded Helium Hotspot App, you can tap the DeepLink Helium Wallet button to add your Helium wallet to SenseCAP App. In this scenario, you can view hotspots information in your wallet and add a new hotspot to Helium blockchain.
|
||||||
|
* If you don't download Helium Hotspot App, you can add Helium wallet by entering your wallet address. In this scenario, you can only view wallet information.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
**Add Hotspots To The Dashboard**
|
||||||
|
=================================
|
||||||
|
|
||||||
|
Once you add a helium wallet to **SenseCAP Hotspot** and add the hotspots from your wallet, you will view the **Hotspots**, **Activities**, and **Notifications**(coming soon ) in the Helium wallet.
|
||||||
|
|
||||||
|
<iframe width={560} height={315} src="https://www.youtube.com/embed/h_0MtD7A8G0" title="YouTube video player" frameBorder={0} allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowFullScreen />
|
||||||
|
|
||||||
|
<iframe width={560} height={315} src="https://www.youtube.com/embed/8eDJnLzftwc" title="YouTube video player" frameBorder={0} allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowFullScreen />
|
||||||
|
|
||||||