SAKURA Internet / SakuraIO Featured

SAKURA Internet IoT Communication Module Library for mbed

Dependents:   patlite_sakuraio sakuraio_lte_firmwareupdater shownet2017-iinebutton patlite_sakuraio_stack ... more

SAKURA Internet IoT Communication Module Library for mbed

Sakura Communication Module (with sakura.io) library for mbed.

Support

This library supports following products.

Reference

Please see the datasheet.

License

The MIT License (MIT)

Copyright (c) SAKURA Internet Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

SakuraIO/commands.h@3:c54a1eba22c4, 2016-11-19 (annotated)

Committer:
chibiegg
Date:
Sat Nov 19 15:19:49 2016 +0000
Revision:
3:c54a1eba22c4
Parent:
0:8d34375d954c
Child:
11:16e726ca39c6
add license

Who changed what in which revision?

UserRevisionLine numberNew contents of line
chibiegg 3:c54a1eba22c4 1 /* SAKURA Internet IoT Communication Module Library for mbed
chibiegg 3:c54a1eba22c4 2 *
chibiegg 3:c54a1eba22c4 3 * The MIT License (MIT)
chibiegg 3:c54a1eba22c4 4 *
chibiegg 3:c54a1eba22c4 5 * Copyright (c) SAKURA Internet Inc.
chibiegg 3:c54a1eba22c4 6 *
chibiegg 3:c54a1eba22c4 7 * Permission is hereby granted, free of charge, to any person obtaining a copy
chibiegg 3:c54a1eba22c4 8 * of this software and associated documentation files (the "Software"),
chibiegg 3:c54a1eba22c4 9 * to deal in the Software without restriction, including without limitation
chibiegg 3:c54a1eba22c4 10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
chibiegg 3:c54a1eba22c4 11 * and/or sell copies of the Software, and to permit persons to whom the Software
chibiegg 3:c54a1eba22c4 12 * is furnished to do so, subject to the following conditions:
chibiegg 3:c54a1eba22c4 13 *
chibiegg 3:c54a1eba22c4 14 * The above copyright notice and this permission notice shall be included
chibiegg 3:c54a1eba22c4 15 * in all copies or substantial portions of the Software.
chibiegg 3:c54a1eba22c4 16 *
chibiegg 3:c54a1eba22c4 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
chibiegg 3:c54a1eba22c4 18 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
chibiegg 3:c54a1eba22c4 19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
chibiegg 3:c54a1eba22c4 20 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
chibiegg 3:c54a1eba22c4 21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
chibiegg 3:c54a1eba22c4 22 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
chibiegg 3:c54a1eba22c4 23 */
chibiegg 3:c54a1eba22c4 24
spiralray 0:8d34375d954c 25 // Common
spiralray 0:8d34375d954c 26 #define CMD_GET_CONNECTION_STATUS 0x01 // OK
spiralray 0:8d34375d954c 27 #define CMD_GET_SIGNAL_QUALITY 0x02 // OK
spiralray 0:8d34375d954c 28 #define CMD_GET_DATETIME 0x03 // OK
spiralray 0:8d34375d954c 29 #define CMD_ECHO_BACK 0x0f // OK
spiralray 0:8d34375d954c 30
spiralray 0:8d34375d954c 31 // IO
spiralray 0:8d34375d954c 32 #define CMD_READ_ADC 0x10 // OK
spiralray 0:8d34375d954c 33
spiralray 0:8d34375d954c 34 // Transmit
spiralray 0:8d34375d954c 35 #define CMD_TX_ENQUEUE 0x20 // OK
spiralray 0:8d34375d954c 36 #define CMD_TX_SENDIMMED 0x21 // OK
spiralray 0:8d34375d954c 37 #define CMD_TX_LENGTH 0x22 // OK
spiralray 0:8d34375d954c 38 #define CMD_TX_CLEAR 0x23 // OK
spiralray 0:8d34375d954c 39 #define CMD_TX_SEND 0x24 // OK
spiralray 0:8d34375d954c 40 #define CMD_TX_STAT 0x25 // OK
spiralray 0:8d34375d954c 41
spiralray 0:8d34375d954c 42 // Receive
spiralray 0:8d34375d954c 43 #define CMD_RX_DEQUEUE 0x30 // OK
spiralray 0:8d34375d954c 44 #define CMD_RX_PEEK 0x31 // OK
spiralray 0:8d34375d954c 45 #define CMD_RX_LENGTH 0x32 // OK
spiralray 0:8d34375d954c 46 #define CMD_RX_CLEAR 0x33 // OK
spiralray 0:8d34375d954c 47
spiralray 0:8d34375d954c 48 // File Download
spiralray 0:8d34375d954c 49 #define CMD_START_FILE_DOWNLOAD 0x40 // OK
spiralray 0:8d34375d954c 50 #define CMD_GET_FILE_METADATA 0x41 // OK
spiralray 0:8d34375d954c 51 #define CMD_GET_FILE_DOWNLOAD_STATUS 0x42 // OK
spiralray 0:8d34375d954c 52 #define CMD_CANCEL_FILE_DOWNLOAD 0x43 // OK
spiralray 0:8d34375d954c 53 #define CMD_GET_FILE_DATA 0x44 // OK
spiralray 0:8d34375d954c 54
spiralray 0:8d34375d954c 55 // Operation
spiralray 0:8d34375d954c 56 #define CMD_GET_PRODUCT_ID 0xA0 // OK
spiralray 0:8d34375d954c 57 #define CMD_GET_UNIQUE_ID 0xA1 // OK
spiralray 0:8d34375d954c 58 #define CMD_GET_FIRMWARE_VERSION 0xA2 // OK
spiralray 0:8d34375d954c 59 #define CMD_UNLOCK 0xA8 // OK
spiralray 0:8d34375d954c 60 #define CMD_UPDATE_FIRMWARE 0xA9 // OK
spiralray 0:8d34375d954c 61 #define CMD_GET_UPDATE_FIRMWARE_STATUS 0xAA // OK
spiralray 0:8d34375d954c 62 #define CMD_SOFTWARE_RESET 0xAF // OK
spiralray 0:8d34375d954c 63
spiralray 0:8d34375d954c 64
spiralray 0:8d34375d954c 65 // Response
spiralray 0:8d34375d954c 66 #define CMD_ERROR_NONE 0x01
spiralray 0:8d34375d954c 67 #define CMD_ERROR_PARITY 0x02
spiralray 0:8d34375d954c 68 #define CMD_ERROR_MISSING 0x03
spiralray 0:8d34375d954c 69 #define CMD_ERROR_INVALID_SYNTAX 0x04
spiralray 0:8d34375d954c 70 #define CMD_ERROR_RUNTIME 0x05
spiralray 0:8d34375d954c 71 #define CMD_ERROR_LOCKED 0x06
spiralray 0:8d34375d954c 72 #define CMD_ERROR_BUSY 0x07