Skip to content

Commit bbf8504

Browse files
siddacioussiddacious
committed
updating readme and removing travis
1 parent 2f4edf7 commit bbf8504

File tree

6 files changed

+206
-40
lines changed

6 files changed

+206
-40
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
html/

‎.travis.yml‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎README.md‎

Lines changed: 51 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,18 @@
1-
Adafruit LSM9DS0 Library
2-
========================
1+
# Adafruit LSM9DS0 Library [![Build Status](https://github.com/adafruit/Adafruit_LSM9DS0_Library/workflows/Arduino%20Library%20CI/badge.svg)](https://github.com/adafruit/Adafruit_LSM9DS0_Library/actions)[![Documentation](https://github.com/adafruit/ci-arduino/blob/master/assets/doxygen_badge.svg)](http://adafruit.github.io/Adafruit_LSM9DS0_Library/html/index.html)
32

4-
This is a library for the Adafruit triple-axis accelerometer/magnetometer/gyroscope LSM9DS0 breakouts
3+
[<img src="https://cdn-shop.adafruit.com/970x728/2021-00.jpg" width="500px">](https://www.adafruit.com/products/2021)
54

6-
Designed specifically to work with the Adafruit LSM9DS0 Breakout & Flora Sensor
7-
----> https://www.adafruit.com/products/2020
8-
----> https://www.adafruit.com/products/2021
95

10-
These sensors use I2C to communicate, 2 pins are required to interface
11-
Adafruit invests time and resources providing this open source code,
12-
please support Adafruit and open-source hardware by purchasing
13-
products from Adafruit!
6+
This is the Arduino library for the Adafruit triple-axis accelerometer/magnetometer/gyroscope LSM9DS0 breakouts
147

15-
Check out the links above for our tutorials and wiring diagrams
8+
Designed specifically to work with the Adafruit LSM9DS0 Breakout & Flora Sensor
9+
* https://www.adafruit.com/products/2020
10+
* https://www.adafruit.com/products/2021
1611

17-
Written by Kevin Townsend for Adafruit Industries.
18-
BSD license, all text above must be included in any redistribution
12+
**note** both of the above sensors are discontinued. Check out the update, the [LSM9DS1 breakout](https://www.adafruit.com/product/3387) and [and its corresponding library](https://github.com/adafruit/Adafruit_LSM9DS1)
1913

20-
To download. click the DOWNLOADS button in the top right corner, rename the uncompressed folder Adafruit_LSM9DS0. Check that the Adafruit_LSM9DS0 folder contains Adafruit_LSM9DS0.cpp and Adafruit_LSM9DS0.h
2114

22-
Place the Adafruit_LSM9DS0 library folder your *arduinosketchfolder*/libraries/ folder. You may need to create the libraries subfolder if its your first library. Restart the IDE.
15+
Check out the links above for our tutorials and wiring diagrams
2316

2417
<!-- START COMPATIBILITY TABLE -->
2518

@@ -53,3 +46,46 @@ STM32F2 | | | X |
5346

5447
<!-- END COMPATIBILITY TABLE -->
5548

49+
# Installation
50+
To install, use the Arduino Library Manager and search for "Adafruit LSM9DS0 Library" and install the library.
51+
52+
## Dependencies
53+
* [Adafruit BusIO](https://github.com/adafruit/Adafruit_BusIO)
54+
* [Adafruit Unified Sensor Driver](https://github.com/adafruit/Adafruit_Sensor)
55+
* [Adafruit GFX Library](https://github.com/adafruit/Adafruit-GFX-Library)
56+
57+
# Contributing
58+
59+
Contributions are welcome! Please read our [Code of Conduct](https://github.com/adafruit/Adafruit_LSM9DS0_Library/blob/master/CODE_OF_CONDUCT.md>)
60+
before contributing to help this project stay welcoming.
61+
62+
## Documentation and doxygen
63+
Documentation is produced by doxygen. Contributions should include documentation for any new code added.
64+
65+
Some examples of how to use doxygen can be found in these guide pages:
66+
67+
https://learn.adafruit.com/the-well-automated-arduino-library/doxygen
68+
69+
https://learn.adafruit.com/the-well-automated-arduino-library/doxygen-tips
70+
71+
## Formatting and clang-format
72+
This library uses [`clang-format`](https://releases.llvm.org/download.html) to standardize the formatting of `.cpp` and `.h` files.
73+
Contributions should be formatted using `clang-format`:
74+
75+
The `-i` flag will make the changes to the file.
76+
```bash
77+
clang-format -i *.cpp *.h
78+
```
79+
If you prefer to make the changes yourself, running `clang-format` without the `-i` flag will print out a formatted version of the file. You can save this to a file and diff it against the original to see the changes.
80+
81+
Note that the formatting output by `clang-format` is what the automated formatting checker will expect. Any diffs from this formatting will result in a failed build until they are addressed. Using the `-i` flag is highly recommended.
82+
83+
### clang-format resources
84+
* [Binary builds and source available on the LLVM downloads page](https://releases.llvm.org/download.html)
85+
* [Documentation and IDE integration](https://clang.llvm.org/docs/ClangFormat.html)
86+
87+
## About this Driver
88+
Written by Kevin (KTOWN) Townsend for Adafruit Industries.
89+
BSD license, check license.txt for more information
90+
All text above must be included in any redistribution
91+

‎code-of-conduct.md‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Adafruit Community Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and leaders pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level or type of
9+
experience, education, socio-economic status, nationality, personal appearance,
10+
race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
We are committed to providing a friendly, safe and welcoming environment for
15+
all.
16+
17+
Examples of behavior that contributes to creating a positive environment
18+
include:
19+
20+
* Be kind and courteous to others
21+
* Using welcoming and inclusive language
22+
* Being respectful of differing viewpoints and experiences
23+
* Collaborating with other community members
24+
* Gracefully accepting constructive criticism
25+
* Focusing on what is best for the community
26+
* Showing empathy towards other community members
27+
28+
Examples of unacceptable behavior by participants include:
29+
30+
* The use of sexualized language or imagery and sexual attention or advances
31+
* The use of inappropriate images, including in a community member's avatar
32+
* The use of inappropriate language, including in a community member's nickname
33+
* Any spamming, flaming, baiting or other attention-stealing behavior
34+
* Excessive or unwelcome helping; answering outside the scope of the question
35+
asked
36+
* Trolling, insulting/derogatory comments, and personal or political attacks
37+
* Public or private harassment
38+
* Publishing others' private information, such as a physical or electronic
39+
address, without explicit permission
40+
* Other conduct which could reasonably be considered inappropriate
41+
42+
The goal of the standards and moderation guidelines outlined here is to build
43+
and maintain a respectful community. We ask that you don’t just aim to be
44+
"technically unimpeachable", but rather try to be your best self.
45+
46+
We value many things beyond technical expertise, including collaboration and
47+
supporting others within our community. Providing a positive experience for
48+
other community members can have a much more significant impact than simply
49+
providing the correct answer.
50+
51+
## Our Responsibilities
52+
53+
Project leaders are responsible for clarifying the standards of acceptable
54+
behavior and are expected to take appropriate and fair corrective action in
55+
response to any instances of unacceptable behavior.
56+
57+
Project leaders have the right and responsibility to remove, edit, or
58+
reject messages, comments, commits, code, issues, and other contributions
59+
that are not aligned to this Code of Conduct, or to ban temporarily or
60+
permanently any community member for other behaviors that they deem
61+
inappropriate, threatening, offensive, or harmful.
62+
63+
## Moderation
64+
65+
Instances of behaviors that violate the Adafruit Community Code of Conduct
66+
may be reported by any member of the community. Community members are
67+
encouraged to report these situations, including situations they witness
68+
involving other community members.
69+
70+
You may report in the following ways:
71+
72+
In any situation, you may send an email to <[email protected]>.
73+
74+
On the Adafruit Discord, you may send an open message from any channel
75+
to all Community Helpers by tagging @community helpers. You may also send an
76+
open message from any channel, or a direct message to @kattni#1507,
77+
@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, or
78+
@Andon#8175.
79+
80+
Email and direct message reports will be kept confidential.
81+
82+
In situations on Discord where the issue is particularly egregious, possibly
83+
illegal, requires immediate action, or violates the Discord terms of service,
84+
you should also report the message directly to Discord.
85+
86+
These are the steps for upholding our community’s standards of conduct.
87+
88+
1. Any member of the community may report any situation that violates the
89+
Adafruit Community Code of Conduct. All reports will be reviewed and
90+
investigated.
91+
2. If the behavior is an egregious violation, the community member who
92+
committed the violation may be banned immediately, without warning.
93+
3. Otherwise, moderators will first respond to such behavior with a warning.
94+
4. Moderators follow a soft "three strikes" policy - the community member may
95+
be given another chance, if they are receptive to the warning and change their
96+
behavior.
97+
5. If the community member is unreceptive or unreasonable when warned by a
98+
moderator, or the warning goes unheeded, they may be banned for a first or
99+
second offense. Repeated offenses will result in the community member being
100+
banned.
101+
102+
## Scope
103+
104+
This Code of Conduct and the enforcement policies listed above apply to all
105+
Adafruit Community venues. This includes but is not limited to any community
106+
spaces (both public and private), the entire Adafruit Discord server, and
107+
Adafruit GitHub repositories. Examples of Adafruit Community spaces include
108+
but are not limited to meet-ups, audio chats on the Adafruit Discord, or
109+
interaction at a conference.
110+
111+
This Code of Conduct applies both within project spaces and in public spaces
112+
when an individual is representing the project or its community. As a community
113+
member, you are representing our community, and are expected to behave
114+
accordingly.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 1.4, available at
120+
<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>,
121+
and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html).
122+
123+
For other projects adopting the Adafruit Community Code of
124+
Conduct, please contact the maintainers of those projects for enforcement.
125+
If you wish to use this code of conduct for your own project, consider
126+
explicitly mentioning your moderation policy or making a copy with your
127+
own moderation policy so as to avoid confusion.

‎library.properties‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name=Adafruit LSM9DS0 Library
2-
version=2.0.0
2+
version=2.0.1
33
author=Adafruit
44
maintainer=Adafruit <[email protected]>
55
sentence=Arduino library for LSM9DS0 9-DOF sensor board.

‎license.txt‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Software License Agreement (BSD License)
2+
3+
Copyright (c) 2020 Kevin (KTOWN) Townsend for Adafruit Industries
4+
All rights reserved.
5+
6+
Redistribution and use in source and binary forms, with or without
7+
modification, are permitted provided that the following conditions are met:
8+
1. Redistributions of source code must retain the above copyright
9+
notice, this list of conditions and the following disclaimer.
10+
2. Redistributions in binary form must reproduce the above copyright
11+
notice, this list of conditions and the following disclaimer in the
12+
documentation and/or other materials provided with the distribution.
13+
3. Neither the name of the copyright holders nor the
14+
names of its contributors may be used to endorse or promote products
15+
derived from this software without specific prior written permission.
16+
17+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
18+
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
21+
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24+
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
26+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

0 commit comments

Comments
 (0)