@google-cloud/iot

Cloud IoT API client for Node.js
google apis client google api client google apis google api google google cloud platform google cloud cloud google iot iot Cloud IoT API


Summary

Project Name @google-cloud/iot Project Url https://github.com/googleapis/nodejs-iot#readme
InceptionYear 2018-07-18 17:50:43 更新时间 2020-05-19 05:03:48
IssueManagement https://github.com/googleapis/nodejs-iot/issues Licenses Apache-2.0
仓库地址 git+https://github.com/googleapis/nodejs-iot.git 用户数 0
Node Engine >=10 文件大小 150.3 KB
install test samples-test lint docs system-test fix docs-test predocs-test clean compile compile-protos prepare prelint precompile

项目介绍

[//]: # "This README.md file is auto-generated, all changes to this file will be lost." [//]: # "To regenerate it, use `python -m synthtool`." Google Cloud Platform logo # [Google Cloud Internet of Things (IoT) Core: Node.js Client](https://github.com/googleapis/nodejs-iot) [![release level](https://img.shields.io/badge/release%20level-general%20availability%20%28GA%29-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages) [![npm version](https://img.shields.io/npm/v/@google-cloud/iot.svg)](https://www.npmjs.org/package/@google-cloud/iot) [![codecov](https://img.shields.io/codecov/c/github/googleapis/nodejs-iot/master.svg?style=flat)](https://codecov.io/gh/googleapis/nodejs-iot) > Node.js idiomatic client for [Cloud IoT Core][product-docs]. [Google Cloud Internet of Things (IoT) Core](https://cloud.google.com/iot/docs) 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. * [Google Cloud Internet of Things (IoT) Core Node.js Client API Reference][client-docs] * [Google Cloud Internet of Things (IoT) Core Documentation][product-docs] * [github.com/googleapis/nodejs-iot](https://github.com/googleapis/nodejs-iot) Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in [Client Libraries Explained][explained]. [explained]: https://cloud.google.com/apis/docs/client-libraries-explained **Table of contents:** * [Quickstart](#quickstart) * [Before you begin](#before-you-begin) * [Installing the client library](#installing-the-client-library) * [Using the client library](#using-the-client-library) * [Samples](#samples) * [Versioning](#versioning) * [Contributing](#contributing) * [License](#license) ## Quickstart ### Before you begin 1. [Select or create a Cloud Platform project][projects]. 1. [Enable billing for your project][billing]. 1. [Enable the Google Cloud Internet of Things (IoT) Core API][enable_api]. 1. [Set up authentication with a service account][auth] so you can access the API from your local workstation. ### Installing the client library ```bash npm install @google-cloud/iot ``` ### Using the client library ```javascript const iot = require('@google-cloud/iot'); const client = new iot.v1.DeviceManagerClient(); async function quickstart() { const projectId = await client.getProjectId(); const parent = client.locationPath(projectId, 'us-central1'); const [resources] = await client.listDeviceRegistries({parent}); console.log(`${resources.length} resource(s) found.`); for (const resource of resources) { console.log(resource); } } quickstart(); ``` ## Samples Samples are in the [`samples/`](https://github.com/googleapis/nodejs-iot/tree/master/samples) directory. The samples' `README.md` has instructions for running the samples. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | | Quickstart | [source code](https://github.com/googleapis/nodejs-iot/blob/master/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-iot&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) | The [Google Cloud Internet of Things (IoT) Core Node.js Client API Reference][client-docs] documentation also contains samples. ## Supported Node.js Versions Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/). Libraries are compatible with all current _active_ and _maintenance_ versions of Node.js. Client libraries targetting some end-of-life versions of Node.js are available, and can be installed via npm [dist-tags](https://docs.npmjs.com/cli/dist-tag). The dist-tags follow the naming convention `legacy-(version)`. _Legacy Node.js versions are supported as a best effort:_ * Legacy versions will not be tested in continuous integration. * Some security patches may not be able to be backported. * Dependencies will not be kept up-to-date, and features will not be backported. #### Legacy tags available * `legacy-8`: install client libraries from this dist-tag for versions compatible with Node.js 8. ## Versioning This library follows [Semantic Versioning](http://semver.org/). This library is considered to be **General Availability (GA)**. This means it is 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 **GA** libraries are addressed with the highest priority. More Information: [Google Cloud Platform Launch Stages][launch_stages] [launch_stages]: https://cloud.google.com/terms/launch-stages ## Contributing Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-iot/blob/master/CONTRIBUTING.md). Please note that this `README.md`, the `samples/README.md`, and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`) are generated from a central template. To edit one of these files, make an edit to its template in this [directory](https://github.com/googleapis/synthtool/tree/master/synthtool/gcp/templates/node_library). ## License Apache Version 2.0 See [LICENSE](https://github.com/googleapis/nodejs-iot/blob/master/LICENSE) [client-docs]: https://googleapis.dev/nodejs/iot/latest [product-docs]: https://cloud.google.com/iot [shell_img]: https://gstatic.com/cloudssh/images/open-btn.png [projects]: https://console.cloud.google.com/project [billing]: https://support.google.com/cloud/answer/6293499#enable-billing [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=cloudiot.googleapis.com [auth]: https://cloud.google.com/docs/authentication/getting-started

Dependencys

GroupId ArtifactID Version 引用量
Google API Authors google-gax 2.4.0 73

开发依赖

GroupId ArtifactID Version 引用量
Ben Coe c8 7.1.2 430
Google Inc. gts 2.0.2 707
Michael Mathews jsdoc 3.6.4 9246
Braintreeps jsdoc-fresh 1.0.2 41
Google LLC jsdoc-region-tag 1.0.4 48
justinbeckwith linkinator 2.1.1 104
Tobias Koppers @sokra null-loader 4.0.0 1406
Google LLC pack-n-play 1.0.0-2 0
John Reilly ts-loader 7.0.5 19144
bebraw webpack-cli 3.3.11 48902