Skip to content

Commit

Permalink
Moved repository from SV-Zanshin to Zanduino
Browse files Browse the repository at this point in the history
  • Loading branch information
Arnd authored and Arnd committed Dec 9, 2020
1 parent 3233d96 commit cbb7cf1
Show file tree
Hide file tree
Showing 9 changed files with 158 additions and 86 deletions.
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Description
_Please include a text summary of the change and which issue(s) is/are fixed or addressed. Should the change have any dependencies
_Please include a text summary of the change and which issue(s) is/are fixed or addressed. Should the change have any dependencies
then these should be listed here._

Fixes # (issue)
Expand All @@ -25,8 +25,8 @@ _Please describe the tests that you ran to verify your changes. Provide instruct
**Test Configuration**:
* Arduino version:
* Arduino Hardware:
* SDK: (Arduino IDE, Atmel Studio, Visual Studio, Visual Micro, etc.)
* Development sytem: (Windows, Web, Linux, etc.)
* SDK: (Arduino IDE, Atmel Studio, Visual Studio with Visual Micro, etc.)
* Development system: (Windows, Web, Linux, etc.)

# Checklist:

Expand Down
11 changes: 7 additions & 4 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# MicrochipSRAM library<br>[![Build Status](https://travis-ci.com/SV-Zanshin/MicrochipSRAM.svg?branch=master)](https://travis-ci.com/SV-Zanshin/MicrochipSRAM) [![DOI](https://www.zenodo.org/badge/74214598.svg)](https://www.zenodo.org/badge/latestdoi/74214598) [![arduino-library-badge](https://www.ardu-badge.com/badge/MicrochipSRAM.svg?)](https://www.ardu-badge.com/MicrochipSRAM) [![Doxygen](https://github.com/SV-Zanshin/BME680/blob/master/Images/Doxygen-complete.svg)](https://sv-zanshin.github.io/MicrochipSRAM/html/index.html) [![Wiki](https://github.com/SV-Zanshin/BME680/blob/master/Images/Documentation-wiki.svg)](https://github.com/SV-Zanshin/MicrochipSRAM/wiki)
<img src="https://github.com/SV-Zanshin/MicrochipSRAM/blob/master/Images/Microchip23LCV1024.jpg" width="175" align="right"/> *Arduino* library which defines methods for accessing any the Microchip SRAM and SNVRAM SPI family memory chips. [Microchip](http://www.microchip.com/design-centers/memory/serial-sram-serial-nvsram/overview) offers a number of volatile and nonvolatile memory chips that use the SPI protocol. One thing that differentiates these chips from others on the market is that they have an unlimited number of write cycles, so the programmer doesn't have to worry about load leveling and writing only pages/blocks at a time to avoid memory hardware degradation or failure. The memory is also fast enough so that no delays need be introduced when using SPI.
[![License: GPL v3](https://zanduino.github.io/Badges/GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Build](https://github.com/Zanduino/MicrochipSRAM/workflows/Build/badge.svg)](https://github.com/Zanduino/MicrochipSRAM/actions?query=workflow%3ABuild) [![Format](https://github.com/Zanduino/MicrochipSRAM/workflows/Format/badge.svg)](https://github.com/Zanduino/MicrochipSRAM/actions?query=workflow%3AFormat) [![Wiki](https://zanduino.github.io/Badges/Documentation-Badge.svg)](https://github.com/Zanduino/MicrochipSRAM/wiki) [![Doxygen](https://github.com/Zanduino/MicrochipSRAM/workflows/Doxygen/badge.svg)](https://Zanduino.github.io/MicrochipSRAM/html/index.html) [![arduino-library-badge](https://www.ardu-badge.com/badge/MicrochipSRAM.svg?)](https://www.ardu-badge.com/MicrochipSRAM)

# MicrochipSRAM library<br>

<img src="https://github.com/Zanduino/MicrochipSRAM/blob/master/Images/Microchip23LCV1024.jpg" width="175" align="right"/> *Arduino* library which defines methods for accessing any the Microchip SRAM and SNVRAM SPI family memory chips. [Microchip](http://www.microchip.com/design-centers/memory/serial-sram-serial-nvsram/overview) offers a number of volatile and nonvolatile memory chips that use the SPI protocol. One thing that differentiates these chips from others on the market is that they have an unlimited number of write cycles, so the programmer doesn't have to worry about load leveling and writing only pages/blocks at a time to avoid memory hardware degradation or failure. The memory is also fast enough so that no delays need be introduced when using SPI.

This _Arduino_ library offers a number of methods that allow easy reading and writing to/from the memory as well as a method for detecting exactly which one of the supported memory chips is installed.

Expand Down Expand Up @@ -33,6 +36,6 @@ The following Microchip **SRAM** and **SNVRAM** chips can be accessed using this
</tr>
</table>

See the [Wiki pages](https://github.com/SV-Zanshin/MicrochipSRAM/wiki) for details of the class and the variables / functions accessible in it. The doxygen documentation can be found at [Doxygen Documentation](https://sv-zanshin.github.io/MicrochipSRAM/html/index.html)
See the [Wiki pages](https://github.com/Zanduino/MicrochipSRAM/wiki) for details of the class and the variables / functions accessible in it. The doxygen documentation can be found at [Doxygen Documentation](https://Zanduino.github.io/MicrochipSRAM/html/index.html)

![Zanshin Logo](https://www.sv-zanshin.com/r/images/site/gif/zanshinkanjitiny.gif) <img src="https://www.sv-zanshin.com/r/images/site/gif/zanshintext.gif" width="75"/>
[![Zanshin Logo](https://zanduino.github.io/Images/zanshinkanjitiny.gif) <img src="https://zanduino.github.io/Images/zanshintext.gif" width="75"/>](https://www.sv-zanshin.com)
37 changes: 37 additions & 0 deletions .github/workflows/ci-clang-format.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
####################################################################################################
## YAML file for the github Action that performs "clang-format" to check the c++ source files for ##
## adherence to the defined standards. If no ".clang-format" file is defined at the root of the ##
## project then the standard file is copied there. The default clang-format style is "Google", ##
## with a couple of minor tweaks. ##
## ##
## ##
## Version Date Developer Comments ##
## ======= ========== ============== ============================================================ ##
## 1.0.0 2020-12-09 SV-Zanshin Cloned from common project ##
### ##
####################################################################################################
name: 'Format'
on:
push:
pull_request:
workflow_dispatch:
jobs:
source-checks:
name: 'clang-format'
runs-on: ubuntu-latest
steps:
- name: 'Install "Python"'
uses: actions/setup-python@v1
with:
python-version: '3.x'
- name: 'Checkout the repository'
uses: actions/checkout@v2
- name: 'Checkout the "Zanduino/Common" repository'
uses: actions/checkout@v2
with:
repository: Zanduino/Common
path: Common
- name: 'Install "clang-format"'
run: bash ${GITHUB_WORKSPACE}/Common/Scripts/install_clang_actions.sh
- name: 'Check formatting of all c++ files'
run: python3 ${GITHUB_WORKSPACE}/Common/Python/run-clang-format.py -e "ci/*" -e "bin/*" -r .
34 changes: 34 additions & 0 deletions .github/workflows/ci-compile.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
####################################################################################################
## YAML file for github Actions that will attempt to compile the c++ artefacts using the Arduino ##
## CLI for various platforms. ##
## ##
## Version Date Developer Comments ##
## ======= ========== ============== ============================================================ ##
## 1.0.0 2020-12-09 SV-Zanshin Cloned from common project ##
## ##
####################################################################################################
name: 'Build'
on:
push:
pull_request:
workflow_dispatch:
jobs:
compile-on-platforms:
name: 'Compile using Arduino IDE on selected platforms'
runs-on: ubuntu-latest
steps:
- name: 'Install "python 3.x" package'
uses: actions/setup-python@v1
with:
python-version: '3.x'
- name: 'Checkout the repository from github'
uses: actions/checkout@v2
- name: 'Checkout the "Zanduino/Common" repository from github'
uses: actions/checkout@v2
with:
repository: Zanduino/Common
path: Common
- name: 'Install Arduino CLI package'
run: bash ${GITHUB_WORKSPACE}/Common/Scripts/install_arduino_cli.sh
- name: 'Run master compile python program'
run: python3 ${GITHUB_WORKSPACE}/Common/Python/build_platform.py zanshin_platforms
43 changes: 43 additions & 0 deletions .github/workflows/ci-doxygen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
####################################################################################################
## YAML file for github Actions that will perform project checking for adhering to doxygen ##
## documentation standards and to also deploy the generated HTML documentation to gh-pages ##
## ##
## ##
## Version Date Developer Comments ##
## ======= ========== ============== ============================================================ ##
## 1.0.0 2020-12-09 SV-Zanshin Cloned from common project ##
### ##
####################################################################################################
name: 'Doxygen'

####################################################################################################
## Action runs when committing (push), doing a pull request, or a workflow_dispatch ##
####################################################################################################
on:
push:
pull_request:
workflow_dispatch:
jobs:
doxygen:
name: 'Generate doxygen'
runs-on: ubuntu-latest
steps:
- name: 'Checkout the repository from github'
uses: actions/checkout@v2
- name: 'Checkout the "Zanduino/Common" repository from github'
uses: actions/checkout@v2
with:
repository: Zanduino/Common
path: Common
- name: 'Create doxygen html documentation'
env:
GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }}
##########################################################################################
## The following 5 lines need to be set here each project ##
##########################################################################################
PRETTYNAME: "Microchip SRAM Arduino Library"
PROJECT_NAME: "MicrochipSRAM"
PROJECT_NUMBER: "v1.0.7"
PROJECT_BRIEF: "Arduino Library for an SNVRAM SPI chips from Microchip"
PROJECT_LOGO: ""
run: bash ${GITHUB_WORKSPACE}/Common/Scripts/doxy_gen_and_deploy.sh
44 changes: 0 additions & 44 deletions .travis.yml

This file was deleted.

43 changes: 21 additions & 22 deletions examples/sram_read_write_test/sram_read_write_test.ino
Original file line number Diff line number Diff line change
Expand Up @@ -43,19 +43,18 @@ Written by Arnd\@SV-Zanshin
@section sram_read_write_testversions Changelog
Version| Date | Developer | Comments
------ | ---------- | ------------------- | --------
1.0.2 | 2020-12-02 | SV-Zanshin | Reformatted with clang-format
1.0.1 | 2019-05-29 | SV-Zanshin | Cleaned up comments
1.0.1 | 2019-01-26 | SV-Zanshin | Issue #11 - converted to doxygen style
1.0.0 | 2016-11-16 | SV-Zanshin | Initial coding
Version| Date | Developer | Comments
------ | ---------- | ---------- | --------
1.0.2 | 2020-12-02 | SV-Zanshin | Reformatted with clang-format
1.0.1 | 2019-05-29 | SV-Zanshin | Cleaned up comments
1.0.1 | 2019-01-26 | SV-Zanshin | Issue #11 - converted to doxygen style
1.0.0 | 2016-11-16 | SV-Zanshin | Initial coding
*/
#include <MicrochipSRAM.h> // Include the library
#ifdef __AVR__
const uint8_t SRAM_SS_PIN = A4; ///< Pin for SPI. Change if necessary
const uint8_t SRAM_SS_PIN{A4}; ///< Pin for SPI. Change if necessary
#else
const uint8_t SRAM_SS_PIN = 1; ///< Pin numbers are different on non-AVR
const uint8_t SRAM_SS_PIN{1}; ///< Pin numbers are different on non-AVR
#endif

static MicrochipSRAM memory(SRAM_SS_PIN); // Instantiate the class to the given pin
Expand All @@ -73,14 +72,14 @@ struct testStructType {

testStructType testStruct = {3.14159, "Hello World"}; ///< initialize structure to known values

/*!
@brief Arduino method called once at startup to initialize the system
@details This is an Arduino IDE method which is called first upon boot or
restart. It is only called one time and then control goes to the main
"loop()" method, from which control never returns
@return void
*/
void setup() {
/*!
@brief Arduino method called once at startup to initialize the system
@details This is an Arduino IDE method which is called first upon boot or
restart. It is only called one time and then control goes to the main
"loop()" method, from which control never returns
@return void
*/
Serial.begin(115200);
#ifdef __AVR_ATmega32U4__ // If a 32U4 processor, wait 3 seconds for the serial
// interface to initialize
Expand Down Expand Up @@ -121,13 +120,13 @@ void setup() {
} // of if-then-else a chip was detected
} // of method "setup()"

/*!
@brief Arduino method for the main program loop
@details This is the main program for the Arduino IDE, it is an infinite
loop and keeps on repeating.
@return void
*/
void loop() {
/*!
@brief Arduino method for the main program loop
@details This is the main program for the Arduino IDE, it is an infinite
loop and keeps on repeating.
@return void
*/
while (1)
; // infinite loop, never exits this statement
} // of method "loop()"
4 changes: 2 additions & 2 deletions library.properties
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name=MicrochipSRAM
version=1.0.6
version=1.0.7
author=https://github.com/SV-Zanshin
maintainer=https://github.com/SV-Zanshin
sentence=Access all Microchip SRAM chips
paragraph=Autodetect the Microchip SRAM chip in use and read/write data to and from it
category=Data Storage
url=https://github.com/SV-Zanshin/MicrochipSRAM
url=https://github.com/Zanduino/MicrochipSRAM
architectures=*
22 changes: 11 additions & 11 deletions src/MicrochipSRAM.h
Original file line number Diff line number Diff line change
Expand Up @@ -58,17 +58,17 @@ Written by Arnd\@SV-Zanshin
@section versions Changelog
Version| Date | Developer | Comments
------ | ---------- | ----------------------------- | --------
1.0.6 | 2020-12-02 | https://github.com/SV-Zanshin | Reformatted for clang-format
1.0.5 | 2019-05-28 | https://github.com/SV-Zanshin | Issue #2 - corrected misleading comments
1.0.5 | 2019-01-26 | https://github.com/SV-Zanshin | Issue #1 - converted documentation to doxygen
1.0.4 | 2018-06-25 | https://github.com/SV-Zanshin | Minor changes
1.0.3 | 2017-07-31 | https://github.com/SV-Zanshin | Only function prototypes may contain default values / optional parameter declarations, functions may not as this can cause compiler errors
1.0.2 | 2016-11-20 | https://github.com/SV-Zanshin | Constructor uses CS/SS pin, made "SRAMBytes" public
1.0.1 | 2016-11-19 | https://github.com/SV-Zanshin | Added method "clearMemory"
1.0.0 | 2016-11-19 | https://github.com/SV-Zanshin | Cleaned up, https://github.com/SV-Zanshin/MicrochipSRAM
1.0.b1 | 2016-11-16 | https://github.com/SV-Zanshin | Created class
Version| Date | Developer | Comments
------ | ---------- | ---------- | --------
1.0.6 | 2020-12-02 | SV-Zanshin | Reformatted for clang-format
1.0.5 | 2019-05-28 | SV-Zanshin | Issue #2 - corrected misleading comments
1.0.5 | 2019-01-26 | SV-Zanshin | Issue #1 - converted documentation to doxygen
1.0.4 | 2018-06-25 | SV-Zanshin | Minor changes
1.0.3 | 2017-07-31 | SV-Zanshin | Only function prototypes may contain default values / optional parameter declarations, functions may not as this can cause compiler errors
1.0.2 | 2016-11-20 | SV-Zanshin | Constructor uses CS/SS pin, made "SRAMBytes" public
1.0.1 | 2016-11-19 | SV-Zanshin | Added method "clearMemory"
1.0.0 | 2016-11-19 | SV-Zanshin | Cleaned up, https://github.com/SV-Zanshin/MicrochipSRAM
1.0.b1 | 2016-11-16 | SV-Zanshin | Created class
*/
// clang-format on
#include "Arduino.h" // Arduino data type definitions
Expand Down

0 comments on commit cbb7cf1

Please sign in to comment.