Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #16 (library.properties) and prep for v0.2.0 release #17

Merged
merged 4 commits into from
Dec 26, 2018
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
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

This repository contains the MCCI® ADK, a version of the MCCI XDK adapted for use on Catena®-like Arduinos by [MCCI Corporation](http://www.mcci.com).

[![GitHub release](https://img.shields.io/github/release/mcci-catena/Catena-mcciadk.svg)](https://github.com/mcci-catena/arduino-lorawan/releases/latest) [![GitHub commits](https://img.shields.io/github/commits-since/mcci-catena/Catena-mcciadk/latest.svg)](https://github.com/mcci-catena/Catena-mcciadk/compare/v0.1.4...master)
[![GitHub release](https://img.shields.io/github/release/mcci-catena/Catena-mcciadk.svg)](https://github.com/mcci-catena/arduino-lorawan/releases/latest) [![GitHub commits](https://img.shields.io/github/commits-since/mcci-catena/Catena-mcciadk/latest.svg)](https://github.com/mcci-catena/Catena-mcciadk/compare/v0.2.0...master)
[![Build Status](https://travis-ci.com/mcci-catena/Catena-mcciadk.svg?branch=master)](https://travis-ci.com/mcci-catena/Catena-mcciadk)

**Contents**

<!-- TOC depthFrom:2 updateOnSave:true -->

- [Introduction](#introduction)
Expand All @@ -26,6 +27,7 @@ This repository contains the MCCI&reg; ADK, a version of the MCCI XDK adapted fo
- [Support Open Source Hardware](#support-open-source-hardware)

<!-- /TOC -->

## Introduction

MCCI uses its XDK (cross-platform development kit) for writing portable code for use across development environments, compilers and operating systems. Although we don't think it's really appropriate for Arduino work, we find some of its idioms extremely useful, along with some of the functions.
Expand Down Expand Up @@ -113,16 +115,16 @@ This header file provides a number of portable APIs for use by ADK clients.

- `McciAdkLib_CharIsLower()`, `McciAdkLib_CharIsPrint()`, `McciAdkLib_CharIsUpper()`, `McciAdkLib_CharIsWhite()`, and `McciAdkLib_CharToLower()` duplicate some of the functions of `<ctype.h>`. They're justified because they avoid Unicode and other portability distractions in embedded systems with small memory.

- `McciAdkLib_StringCompareCaseInsensitive()` compares two ASCII strings without considering case, and also without internationalization considerations.
- `McciAdkLib_StringCompareCaseInsensitive()` compares two ASCII strings without considering case, and also without internationalization considerations.

- `McciAdkLib_MultiSzIndex()` is used for handling arrays of string values. Rather than using an array of `char*` pointers, you simply write the values into a string constant separated by "\0" values. For example, for three values, you might write:

```c++
char my_list[] =
"one" "\0"
"two" "\0"
"three" "\0"
;
char my_list[] =
"one" "\0"
"two" "\0"
"three" "\0"
;
```

Then, `McciAdkLib_MultiSzIndex(my_list, 0)` will return a pointer to `"one"`, `McciAdkLib_MultiSzIndex(my_list, 1)` will return `"two"`, and `McciAdkLib_MultiSzIndex(my_list, 2)` will return `"three"`. Other indices will return `nullptr`.
Expand All @@ -137,6 +139,8 @@ This header file provides a number of portable APIs for use by ADK clients.

## Release History

- v0.2.0 is a minor release. The only difference is in library.properties, renaming the library "MCCI Arduino Development Kit ADK" to comply with naming restrictions (issue [#16](https://github.com/mcci-catena/Catena-mcciadk/issues/16)). Also, we discovered a typo in the release tag itself for v0.1.4; the tag says v0.1.14. Rather than fixing this or jumping to v0.1.15, we jumped to v0.2.0.

- v0.1.4 is a minor release. It adds `McciAdkLib_SafeCopyString()` (issue [#8](https://github.com/mcci-catena/Catena-mcciadk/issues/8)). Fixed a bug due to use of dot_a_linkage (issue [#10](https://github.com/mcci-catena/Catena-mcciadk/issues/10)). CI testing was extended to the MCCI STM32-based board support package (v2.0.0 or later).

- v0.1.3 adds documentation, continuous integration with Travis CI, and fixes some compile warnings.
Expand All @@ -147,7 +151,6 @@ If you find a bug you can submit an issue here on github:

https://github.com/mcci-catena/Cantea-mcciadk/issues


Before posting a new issue, please check if the same problem has been already reported by someone else to avoid duplicates.

## License and Credits
Expand All @@ -164,7 +167,7 @@ Terry Moore and ChaeHee Won of MCCI were the pricipal contributors to the code i

MCCI and MCCI Catena are registered trademarks of MCCI Corporation. All other trademarks are the properties of their respective owners.

### Support Open Source Hardware
### Support Open Source Hardware

MCCI invests time and resources providing this open source code, please support MCCI and open-source hardware by purchasing products from MCCI, Adafruit and other open-source hardware/software vendors!

Expand Down
2 changes: 1 addition & 1 deletion VERSION.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v0.1.4
v0.2.0
8 changes: 4 additions & 4 deletions library.properties
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name=Catena MCCI Arduino Development Kit (ADK)
version=0.1.4
name=MCCI Arduino Development Kit ADK
version=0.2.0
author=Terry Moore, ChaeHee Won
maintainer=MCCI Corporation <[email protected]>
sentence=MCCI's XDK ported to Arduino
paragraph=The mcciadk is MCCI's portability toolkit, allowing for code to be reused in multiple environments.
sentence=The MCCI XDK ported to Arduino.
paragraph=The MCCI XDK is a portability toolkit, allowing for C code to be reused in multiple embedded environments. The ADK is a stripped-down version for Arduino and other deeply-embedded environments.
category=Other
url=https://github.com/mcci-catena/Catena-mcciadk
architectures=*
Expand Down