Add example for retrieving a large file from Cloud Storage onto a device #1350
Conversation
There was a problem hiding this comment.
- Fix the lint errors
- Run the doc generator script on README.rst.in
- I see you have a big binary blob in this commit, consider removing it if possible as large files make clones slower and accumulate over time
- Copyright dates typically have year of first publication
| url: https://cloud.google.com/iot/docs | ||
| description: > | ||
| `Google Cloud IoT Core`_ allows developers to easily integrate Publish and | ||
| Subscribe functionality with devices and programmatically manage device |
There was a problem hiding this comment.
s/programmatically manage device auth/programmatically authorize devices./
| @@ -0,0 +1,252 @@ | |||
| # Copyright 2017 Google Inc. All rights reserved. | |||
There was a problem hiding this comment.
If this is the first commit of the file, update year to 2018, same for other headers
| file: gcs_send_to_device.py | ||
| show_help: True | ||
|
|
||
| cloud_client_library: false |
There was a problem hiding this comment.
Did you run the doc generation script to get the restructured text back?
| devices and running them all at the same time. | ||
| """ | ||
|
|
||
| import argparse |
There was a problem hiding this comment.
Fix imports so they pass lint
| return '{}: {}'.format(rc, mqtt.error_string(rc)) | ||
|
|
||
|
|
||
| class Device(object): |
There was a problem hiding this comment.
Sample code generally avoids OO programming because it adds complexity, so use static methods if possible. If you can't work around having your device object, it's ok for now.
There was a problem hiding this comment.
I'd like to keep as-is for now if it's OK.
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| r"""Sample script that pushes a large (~1MB) file to Google Cloud IoT |
There was a problem hiding this comment.
We generally avoid long descriptions in our sample code. Consider moving this content to the docs if possible.
There was a problem hiding this comment.
Done. Comments now just describe what the program does.
| storage_client = storage.Client() | ||
|
|
||
| try: | ||
| bucket = storage_client.create_bucket(bucket_name) |
There was a problem hiding this comment.
Lint doesn't like that this variable is assigned but never used, maybe just don't assign the result from create_bucket
| import json | ||
| import os | ||
|
|
||
| from googleapiclient import discovery |
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| import mock |
There was a problem hiding this comment.
Lint doesn't like the import order here
| @@ -0,0 +1,176 @@ | |||
| # Copyright 2017 Google, Inc. | |||
The main use case for this example is for devices to be able to retrieve configuration updates that are larger than 64 KB, as 64 KB is the current limit (https://cloud.google.com/iot/docs/concepts/limitations). A sample binary file is provided.