diff --git a/.github/.cSpellWords.txt b/.github/.cSpellWords.txt index 158bf07f..3383db94 100644 --- a/.github/.cSpellWords.txt +++ b/.github/.cSpellWords.txt @@ -1,8 +1,25 @@ +CBMC +CBOR CMOCK CMock Cmock Coverity +DCMOCK +DDisable +DNDEBUG +DUNITY MISRA +MQTT Misra +Wunused +abcdefghijklmno +acceptedklmno +cbmc +cbor +cmock coverity +ctest +lcov misra +sinclude +utest diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b4b258e9..5680150e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -73,11 +73,11 @@ jobs: - name: Clone This Repo uses: actions/checkout@v3 - name: Run spellings check - uses: FreeRTOS/CI-CD-GitHub-Actions/rust-spell-check@v2 + uses: FreeRTOS/CI-CD-GitHub-Actions/spellings@v2 with: path: ./ formatting: - runs-on: ubuntu-latest + runs-on: ubuntu-20.04 steps: - uses: actions/checkout@v3 - name: Check formatting diff --git a/README.md b/README.md index 8b5a183a..91cec955 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # AWS IoT Device Shadow library -The AWS IoT Device Shadow library enables you to store and retrieve the current state (the “shadow”) of every registered device. The device’s shadow is a persistent, virtual representation of your device that you can interact with from AWS IoT Core even if the device is offline. The device state is captured as its “shadow” within a [JSON](https://www.json.org/) document. The device can send commands over MQTT to get, update and delete its latest state as well as receive notifications over MQTT about changes in its state. Each device’s shadow is uniquely identified by the name of the corresponding “thing”, a representation of a specific device or logical entity on the AWS Cloud. See [Managing Devices with AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-thing-management.html) for more information on IoT "thing". More details about AWS IoT Device Shadow can be found in [AWS IoT documentation](https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html). This library is distributed under the [MIT Open Source License](LICENSE). +The AWS IoT Device Shadow library enables you to store and retrieve the current state (the “shadow”) of every registered device. The device’s shadow is a persistent, virtual representation of your device that you can interact with from AWS IoT Core even if the device is offline. The device state is captured as its “shadow” within a [JSON](https://www.json.org/) document. The device can send commands over MQTT to get, update and delete its latest state as well as receive notifications over MQTT about changes in its state. Each device’s shadow is uniquely identified by the name of the corresponding “thing”, a representation of a specific device or logical entity on the AWS Cloud. See [Managing Devices with AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-thing-management.html) for more information on IoT "thing". More details about AWS IoT Device Shadow can be found in [AWS IoT documentation](https://docs.aws.amazon.com/iot/latest/developerguide/iot-device-shadows.html). This library is distributed under the [MIT Open Source License](LICENSE). **Note**: From [v1.1.0](https://github.com/aws/Device-Shadow-for-AWS-IoT-embedded-sdk/tree/v1.1.0) release onwards, you can used named shadow, a feature of the AWS IoT Device Shadow service that allows you to create multiple shadows for a single IoT device. diff --git a/lexicon.txt b/lexicon.txt deleted file mode 100644 index 669550c1..00000000 --- a/lexicon.txt +++ /dev/null @@ -1,117 +0,0 @@ -api -app -aws -br -buffersize -cbmc -colspan -com -config -configpagestyle -configs -const -copydoc -css -defgroup -developerguide -device-shadow-limits -doxygen -endcode -endif -endlink -gcc -generatedtopicstringlength -getshadowoperationlength -gettopicstring -github -gr -html -http -https -ifndef -inc -ingroup -init -iot -iot-core -iso -json -logdebug -logerror -loginfo -logwarn -mainpage -malloc -matchtopic -maxallowedlength -md -mdash -messagetype -mit -mqtt -myshadow -myshadowname -mything -mythingname -noninfringement -op -operationlength -os -outlength -param -pconsumedtopiclength -pmessagetype -pname -pnamelength -png -posix -poutlength -pre -pshadowname -pshadownamelength -pstring -psubstring -pthingname -pthingnamelength -ptopic -ptopicbuffer -ptopicname -rm -sdk -shadowname -shadownamelength -shadowstatus -shadowtopicstringtypedelete -shadowtopicstringtypedeleteaccepted -shadowtopicstringtypedeleterejected -shadowtopicstringtypeget -shadowtopicstringtypegetaccepted -shadowtopicstringtypegetrejected -shadowtopicstringtypemaxnum -shadowtopicstringtypeupdate -shadowtopicstringtypeupdateaccepted -shadowtopicstringtypeupdatedelta -shadowtopicstringtypeupdatedocuments -shadowtopicstringtypeupdaterejected -sizeof -spdx -stdint -stringlength -strlen -structs -sublicense -substringlength -suffixlength -td -testshadowname -testthingname -thingname -thingnamelength -toolchain -topicbuffer -topiclength -topicnamelength -topictype -tr -un -utest