rename as mcp canbus, prepare to publish to library index

Longan-Labs · Oct 31, 2023 · b45437a · b45437a
1 parent 7a2aec0
commit b45437a
Show file tree

Hide file tree

Showing 11 changed files with 36 additions and 42 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 @ Longan Labs
+
+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.
diff --git a/README.md b/README.md
@@ -1,8 +1,10 @@
 # CAN Bus Library 
-
-[![Actions Status](https://github.com/arduino/arduino-cli-example/workflows/test/badge.svg)](https://github.com/arduino/arduino-cli-example/actions)
-[![Spell Check](https://github.com/arduino/compile-sketches/workflows/Spell%20Check/badge.svg)](https://github.com/arduino/compile-sketches/actions?workflow=Spell+Check)
-[![codecov](https://codecov.io/gh/arduino/compile-sketches/branch/main/graph/badge.svg?token=Uv6f1ebMZ4)](https://codecov.io/gh/arduino/compile-sketches)
+[![GitHub](https://img.shields.io/github/license/Longan-Labs/Arduino_CAN_BUS_MCP2515)](https://github.com/Longan-Labs/Arduino_CAN_BUS_MCP2515/blob/master/LICENSE)
+[![Installation instructions](https://www.ardu-badge.com/badge/mcp_canbus.svg?)](https://www.ardu-badge.com/mcp_canbus)
+[![GitHub version](https://img.shields.io/github/release/Longan-Labs/Arduino_CAN_BUS_MCP2515.svg?logo=github&logoColor=ffffff)](https://github.com/Longan-Labs/Arduino_CAN_BUS_MCP2515/releases/latest)
+[![GitHub Release Date](https://img.shields.io/github/release-date/Longan-Labs/Arduino_CAN_BUS_MCP2515.svg?logo=github&logoColor=ffffff)](https://github.com/Longan-Labs/Arduino_CAN_BUS_MCP2515/releases/latest)
+[![GitHub Repo stars](https://img.shields.io/github/stars/Longan-Labs/Arduino_CAN_BUS_MCP2515?logo=github&logoColor=ffffff)](https://github.com/Longan-Labs/Arduino_CAN_BUS_MCP2515/stargazers)
+[![GitHub issues](https://img.shields.io/github/issues/Longan-Labs/Arduino_CAN_BUS_MCP2515.svg?logo=github&logoColor=ffffff)](https://github.com/Longan-Labs/Arduino_CAN_BUS_MCP2515/issues)
 
 Arduino library for MCP2515, it's available for most of theArduino boards, we test it with Arduino UNO, Leonardo, Mega as well as Zero.
 
@@ -119,32 +121,6 @@ If you need a Dev board, plese try,
 - [CANBed M0](https://www.longan-labs.cc/1030014.html)
 - [OBD-II CAN Bus GPS Dev Kit](https://www.longan-labs.cc/1030003.html)
 
-## License
-
-```
-MIT License
-
-Copyright (c) 2018 @ Longan Labs
-
-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.
-```
-
 ## Contact us
 
 If you have any question, please feel free to contact [[email protected]]([email protected])

diff --git a/examples/OBDII_PIDs/getRpm/getRpm.ino b/examples/OBDII_PIDs/getRpm/getRpm.ino
@@ -13,7 +13,7 @@
 ***************************************************************************************************/
 
 #include <SPI.h>
-#include "mcp_can.h"
+#include <mcp_canbus.h>
 
 /* Please modify SPI_CS_PIN to adapt to your board.
 

diff --git a/examples/OBDII_PIDs/getSpeed/getSpeed.ino b/examples/OBDII_PIDs/getSpeed/getSpeed.ino
@@ -13,7 +13,7 @@
 ***************************************************************************************************/
 
 #include <SPI.h>
-#include "mcp_can.h"
+#include <mcp_canbus.h>
 
 /* Please modify SPI_CS_PIN to adapt to your board.
 

diff --git a/examples/recv/recv.ino b/examples/recv/recv.ino
@@ -28,7 +28,7 @@
 */
 
 #include <SPI.h>
-#include "mcp_can.h"
+#include <mcp_canbus.h>
 
 /* Please modify SPI_CS_PIN to adapt to your board.
 

diff --git a/examples/send/send.ino b/examples/send/send.ino
@@ -22,7 +22,7 @@
     #define CAN_1000KBPS        18
 */
 
-#include <mcp_can.h>
+#include <mcp_canbus.h>
 #include <SPI.h>
 
 /* Please modify SPI_CS_PIN to adapt to your board.

diff --git a/examples/set_mask_filter_recv/set_mask_filter_recv.ino b/examples/set_mask_filter_recv/set_mask_filter_recv.ino
@@ -28,10 +28,7 @@
    
 */
 #include <SPI.h>
-#include "mcp_can.h"
-
-#include <SPI.h>
-#include "mcp_can.h"
+#include <mcp_canbus.h>
 
 /* Please modify SPI_CS_PIN to adapt to your board.
 

diff --git a/examples/set_mask_filter_send/set_mask_filter_send.ino b/examples/set_mask_filter_send/set_mask_filter_send.ino
@@ -28,7 +28,7 @@
     OBD-II CAN Bus GPS Dev Kit: https://www.longan-labs.cc/1030003.html 
 */
 
-#include <mcp_can.h>
+#include <mcp_canbus.h>
 #include <SPI.h>
 
 /* Please modify SPI_CS_PIN to adapt to your board.

diff --git a/library.properties b/library.properties
@@ -1,9 +1,9 @@
-name=Arduino CAN Bus Library for MCP2515
+name=mcp_canbus
 version=1.0.0
 author=Longan Labs
 maintainer=Longan Labs
 sentence=A library for MCP2515
 paragraph=Arduino CAN Bus Library for MCP2515
-category=CAN Bus
+category=Communication
 url=https://github.com/Longan-Labs/Aruino_CAN_BUS_MCP2515
 architectures=*
diff --git a/mcp_can.cpp → mcp_canbus.cpp b/mcp_can.cpp → mcp_canbus.cpp
@@ -41,7 +41,7 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
-#include "mcp_can.h"
+#include "mcp_canbus.h"
 
 #define spi_readwrite   SPI.transfer
 #define spi_read()      spi_readwrite(0x00)

diff --git a/mcp_can.h → mcp_canbus.h b/mcp_can.h → mcp_canbus.h