Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,4 @@ jobs:
uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@main
with:
config: .github/memory_statistics_config.json
check_against: docs/doxygen/include/size_table.html
check_against: docs/doxygen/include/size_table.md
2 changes: 1 addition & 1 deletion .github/workflows/memory_statistics.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ jobs:
uses: actions/upload-artifact@v2
with:
name: size_table
path: size_table.html
path: size_table.md
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog for AWS IoT Device Defender Library

## v1.1.1 (July 2021)

### Updates
- [#45](https://github.com/aws/Device-Defender-for-AWS-IoT-embedded-sdk/pull/45) Remove parentheses from key name macros to enable concatenating them with other string literals.

## v1.1.0 (March 2021)

### Updates
Expand Down
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Deviations from the MISRA C:2012 guidelines are documented under [MISRA Deviatio
This library has also undergone static code analysis using [Coverity static analysis](https://scan.coverity.com/),
and validation of memory safety through the [CBMC automated reasoning tool](https://www.cprover.org/cbmc/).

See memory requirements for this library [here](https://docs.aws.amazon.com/embedded-csdk/202103.00/lib-ref/libraries/aws/device-defender-for-aws-iot-embedded-sdk/docs/doxygen/output/html/index.html#defender_memory_requirements).
See memory requirements for this library [here](./docs/doxygen/include/size_table.md).

**AWS IoT Device Defender v1.1.0 [source code](https://github.com/aws/Device-Defender-for-AWS-IoT-embedded-sdk/tree/v1.1.0/source) is part of the [FreeRTOS 202012.01 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.01-LTS) release.**

Expand Down Expand Up @@ -83,7 +83,19 @@ The AWS IoT Embedded C-SDK repository contains a demo showing the use of AWS IoT
Device Defender Client Library [here](https://github.com/aws/aws-iot-device-sdk-embedded-C/tree/main/demos/defender/defender_demo_json)
on a POSIX platform.

## Generating documentation
## Documentation

### Existing documentation
For pre-generated documentation, please see the documentation linked in the locations below:

| Location |
| :-: |
| [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C#releases-and-documentation) |
| [FreeRTOS.org](https://freertos.org/Documentation/api-ref/device-defender-for-aws-iot-embedded-sdk/docs/doxygen/output/html/index.html) |

Note that the latest included version of the AWS IoT Device Defender library may differ across repositories.

### Generating documentation

The Doxygen references were created using Doxygen version 1.8.20. To generate the
Doxygen pages, please run the following command from the root of this repository:
Expand Down
2 changes: 1 addition & 1 deletion docs/doxygen/config.doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = "AWS IoT Device Defender"
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = "v1.1.0"
PROJECT_NUMBER = "v1.1.1"

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down
2 changes: 1 addition & 1 deletion docs/doxygen/pages.dox
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ AWS IoT Device Defender lets you continuously monitor security metrics from devi
@section defender_memory_requirements Memory Requirements
@brief Memory requirements of the AWS IoT Device Defender Client Library.

@include{doc} size_table.html
@include{doc} size_table.md
*/

/**
Expand Down
7 changes: 4 additions & 3 deletions lexicon.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ getdeviceserialnumber
gettopic
github
hed
https
html
https
inc
ingroup
iot
Expand All @@ -57,6 +57,7 @@ logwarn
mainpage
matchapi
matchtopic
md
mdash
memcpy
misra
Expand All @@ -77,8 +78,8 @@ pre
premainingtopic
pthingname
ptopic
remediate
remainingtopiclength
remediate
rm
sdk
strlen
Expand All @@ -94,4 +95,4 @@ tr
udp
uint
utest
xa
xa
2 changes: 1 addition & 1 deletion manifest.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name : "Device-Defender-for-AWS-IoT-embedded-sdk"
version: "v1.1.0"
version: "v1.1.1"
description: |
"Client library for using the AWS IoT Device Defender service on embedded devices.\n"
license: "MIT"
2 changes: 1 addition & 1 deletion source/defender.c
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* AWS IoT Device Defender Client v1.1.0
* AWS IoT Device Defender Client v1.1.1
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to update 2020 to 2021?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We havent updated them in other libraries. Should we?

*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
Expand Down
14 changes: 13 additions & 1 deletion source/include/defender.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* AWS IoT Device Defender Client v1.1.0
* AWS IoT Device Defender Client v1.1.1
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
Expand Down Expand Up @@ -31,6 +31,12 @@
/* Standard includes. */
#include <stdint.h>

/* *INDENT-OFF* */
#ifdef __cplusplus
extern "C" {
#endif
/* *INDENT-ON* */

/* DEFENDER_DO_NOT_USE_CUSTOM_CONFIG allows building the Device Defender library
* without a config file. If a config file is provided, DEFENDER_DO_NOT_USE_CUSTOM_CONFIG
* macro must not be defined.
Expand Down Expand Up @@ -788,4 +794,10 @@ DefenderStatus_t Defender_MatchTopic( const char * pTopic,

/*-----------------------------------------------------------*/

/* *INDENT-OFF* */
#ifdef __cplusplus
}
#endif
/* *INDENT-ON* */

#endif /* DEFENDER_H_ */
2 changes: 1 addition & 1 deletion source/include/defender_config_defaults.h
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* AWS IoT Device Defender Client v1.1.0
* AWS IoT Device Defender Client v1.1.1
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* AWS IoT Device Defender Client v1.1.0
* AWS IoT Device Defender Client v1.1.1
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* AWS IoT Device Defender Client v1.1.0
* AWS IoT Device Defender Client v1.1.1
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
Expand Down
2 changes: 1 addition & 1 deletion test/unit-test/defender_utest.c
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* AWS IoT Device Defender Client v1.1.0
* AWS IoT Device Defender Client v1.1.1
* Copyright (C) 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
Expand Down