Skip to content

Commit b45437a

Browse files
sidney2007sidney2007
committed
rename as mcp canbus, prepare to publish to library index
1 parent 7a2aec0 commit b45437a

File tree

11 files changed

+36
-42
lines changed

11 files changed

+36
-42
lines changed

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018 @ Longan Labs
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 6 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# CAN Bus Library
2-
3-
[![Actions Status](https://github.com/arduino/arduino-cli-example/workflows/test/badge.svg)](https://github.com/arduino/arduino-cli-example/actions)
4-
[![Spell Check](https://github.com/arduino/compile-sketches/workflows/Spell%20Check/badge.svg)](https://github.com/arduino/compile-sketches/actions?workflow=Spell+Check)
5-
[![codecov](https://codecov.io/gh/arduino/compile-sketches/branch/main/graph/badge.svg?token=Uv6f1ebMZ4)](https://codecov.io/gh/arduino/compile-sketches)
2+
[![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)
3+
[![Installation instructions](https://www.ardu-badge.com/badge/mcp_canbus.svg?)](https://www.ardu-badge.com/mcp_canbus)
4+
[![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)
5+
[![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)
6+
[![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)
7+
[![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)
68

79
Arduino library for MCP2515, it's available for most of theArduino boards, we test it with Arduino UNO, Leonardo, Mega as well as Zero.
810

@@ -119,32 +121,6 @@ If you need a Dev board, plese try,
119121
- [CANBed M0](https://www.longan-labs.cc/1030014.html)
120122
- [OBD-II CAN Bus GPS Dev Kit](https://www.longan-labs.cc/1030003.html)
121123
122-
## License
123-
124-
```
125-
MIT License
126-
127-
Copyright (c) 2018 @ Longan Labs
128-
129-
Permission is hereby granted, free of charge, to any person obtaining a copy
130-
of this software and associated documentation files (the "Software"), to deal
131-
in the Software without restriction, including without limitation the rights
132-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
133-
copies of the Software, and to permit persons to whom the Software is
134-
furnished to do so, subject to the following conditions:
135-
136-
The above copyright notice and this permission notice shall be included in all
137-
copies or substantial portions of the Software.
138-
139-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
140-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
141-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
142-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
143-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
144-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
145-
SOFTWARE.
146-
```
147-
148124
## Contact us
149125
150126
If you have any question, please feel free to contact [support@longan-labs.cc](support@longan-labs.cc)

‎examples/OBDII_PIDs/getRpm/getRpm.ino‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
***************************************************************************************************/
1414

1515
#include <SPI.h>
16-
#include "mcp_can.h"
16+
#include <mcp_canbus.h>
1717

1818
/* Please modify SPI_CS_PIN to adapt to your board.
1919

‎examples/OBDII_PIDs/getSpeed/getSpeed.ino‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
***************************************************************************************************/
1414

1515
#include <SPI.h>
16-
#include "mcp_can.h"
16+
#include <mcp_canbus.h>
1717

1818
/* Please modify SPI_CS_PIN to adapt to your board.
1919

‎examples/recv/recv.ino‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
*/
2929

3030
#include <SPI.h>
31-
#include "mcp_can.h"
31+
#include <mcp_canbus.h>
3232

3333
/* Please modify SPI_CS_PIN to adapt to your board.
3434

‎examples/send/send.ino‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
#define CAN_1000KBPS 18
2323
*/
2424

25-
#include <mcp_can.h>
25+
#include <mcp_canbus.h>
2626
#include <SPI.h>
2727

2828
/* Please modify SPI_CS_PIN to adapt to your board.

‎examples/set_mask_filter_recv/set_mask_filter_recv.ino‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,7 @@
2828
2929
*/
3030
#include <SPI.h>
31-
#include "mcp_can.h"
32-
33-
#include <SPI.h>
34-
#include "mcp_can.h"
31+
#include <mcp_canbus.h>
3532

3633
/* Please modify SPI_CS_PIN to adapt to your board.
3734

‎examples/set_mask_filter_send/set_mask_filter_send.ino‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
OBD-II CAN Bus GPS Dev Kit: https://www.longan-labs.cc/1030003.html
2929
*/
3030

31-
#include <mcp_can.h>
31+
#include <mcp_canbus.h>
3232
#include <SPI.h>
3333

3434
/* Please modify SPI_CS_PIN to adapt to your board.

‎library.properties‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
name=Arduino CAN Bus Library for MCP2515
1+
name=mcp_canbus
22
version=1.0.0
33
author=Longan Labs
44
maintainer=Longan Labs
55
sentence=A library for MCP2515
66
paragraph=Arduino CAN Bus Library for MCP2515
7-
category=CAN Bus
7+
category=Communication
88
url=https://github.com/Longan-Labs/Aruino_CAN_BUS_MCP2515
99
architectures=*

mcp_can.cpp renamed to mcp_canbus.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
4242
THE SOFTWARE.
4343
*/
44-
#include "mcp_can.h"
44+
#include "mcp_canbus.h"
4545

4646
#define spi_readwrite SPI.transfer
4747
#define spi_read() spi_readwrite(0x00)

0 commit comments

Comments
 (0)