Package Exports
- @google-cloud/iot
- @google-cloud/iot/build/src/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@google-cloud/iot) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Cloud IoT API: Nodejs Client
This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority
Cloud IoT API client for Node.js
Node.js idiomatic client for [Cloud IoT Core][product-docs].
Google Cloud Internet of Things (IoT) Core is a fully managed service for securely connecting and managing IoT devices, from a few to millions. Ingest data from connected devices and build rich applications that integrate with the other big data services of Google Cloud Platform.
A comprehensive list of changes in each version may be found in the CHANGELOG.
Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.
Table of contents:
Quickstart
Before you begin
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Cloud IoT API API.
- Set up authentication so you can access the API from your local workstation.
Installing the client library
npm install @google-cloud/iotSamples
Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code |
|---|---|
| bind device to gateway | source code |
| create device | source code |
| create device registry | source code |
| delete device | source code |
| delete device registry | source code |
| get device | source code |
| get device registry | source code |
| get iam policy | source code |
| list device config versions | source code |
| list device registries | source code |
| list device states | source code |
| list devices | source code |
| modify cloud to device config | source code |
| send command to device | source code |
| set iam policy | source code |
| test iam permissions | source code |
| unbind device from gateway | source code |
| update device | source code |
| update device registry | source code |
| cloud | source code |
Supported Node.js Versions
Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.
Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:
- Legacy versions are not tested in continuous integration.
- Some security patches and features cannot be backported.
- Dependencies cannot be kept up-to-date.
Client libraries targeting some end-of-life versions of Node.js are available, and
can be installed through npm dist-tags.
The dist-tags follow the naming convention legacy-(version).
For example, npm install @google-cloud/iot@legacy-8 installs client libraries
for versions compatible with Node.js 8.
Versioning
This library follows Semantic Versioning.
More Information: Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See the Contributing Guide.
Please note that this README.md
and a variety of configuration files in this repository (including .nycrc and tsconfig.json)
are generated from a central template.
License
Apache Version 2.0
See LICENSE