Skip to content

Commit

Permalink
Move repo to JSC TechMinds
Browse files Browse the repository at this point in the history
  • Loading branch information
vzahradnik committed Jul 20, 2024
1 parent 563e539 commit b6b9f03
Show file tree
Hide file tree
Showing 41 changed files with 123 additions and 108 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/arduino_ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: Arduino-CI/action@stable-1.x
8 changes: 5 additions & 3 deletions .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,20 @@ on:
jobs:
deploy:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Build
uses: mattnotmitt/doxygen-action@v1.9.5
uses: mattnotmitt/doxygen-action@v1.9.8
with:
doxyfile-path: 'docs/Doxyfile'

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/html
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at info@jsc-electronics.cz. All
reported by contacting the project team at development@jsctm.cz. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Thanks for your interest in contributing to this free open source project! We ap

## Issues
- Do you need help or have a question about using Arduino? Support requests should be made to the appropriate section of the [Arduino forum](http://forum.arduino.cc) rather than an issue report. **Issue reports are to be used to report bugs or make feature requests only.**
- Search [existing pull requests and issues](https://github.com/JSC-electronics/ObjectButton/issues?q=) to be sure it hasn't already been reported. If you have additional information to provide about an existing issue then please comment on that issue.
- Search [existing pull requests and issues](https://github.com/JSC-TechMinds/ObjectButton/issues?q=) to be sure it hasn't already been reported. If you have additional information to provide about an existing issue then please comment on that issue.
- State the newest version of the Arduino IDE you have verified the issue with and which operating system you are using.
- If you are using this library on PlatformIO, report version of PlatformIO Core and which operating system you are using.
- The issue title should be concise yet descriptive. Vague titles make it difficult to know the purpose of the issue when looking through the list of reports and may cause your issue to not be given proper attention.
Expand All @@ -13,7 +13,7 @@ Thanks for your interest in contributing to this free open source project! We ap
- If you find a solution to your problem update your issue report with an explanation of how you were able to fix it and close the issue.

## Pull Requests
- Search [existing pull requests](https://github.com/JSC-electronics/ObjectButton/pulls?q=) to see if one has already been submitted for this change. Search the [issues](https://github.com/JSC-electronics/ObjectButton/issues?q=is%3Aissue) to see if there has been a discussion on this topic and whether your pull request can close any issues.
- Search [existing pull requests](https://github.com/JSC-TechMinds/ObjectButton/pulls?q=) to see if one has already been submitted for this change. Search the [issues](https://github.com/JSC-TechMinds/ObjectButton/issues?q=is%3Aissue) to see if there has been a discussion on this topic and whether your pull request can close any issues.
- Code formatting should be consistent with the style used in the existing code.
- Don't leave commented out code. A record of this code is already preserved in the commit history.
- All commits must be atomic. This means that the commit completely accomplishes a single task. Each commit should result in fully functional code. Multiple tasks should not be combined in a single commit, but a single task should not be split over multiple commits (e.g. one commit per file modified is not a good practice). For more information see http://www.freshconsulting.com/atomic-commits.
Expand All @@ -29,7 +29,7 @@ Thanks for your interest in contributing to this free open source project! We ap
- Rebasing pull requests is OK and encouraged. After submitting your pull request some changes may be requested. Rather than adding unnecessary extra commits to the pull request, you can squash these changes into the existing commit and then do a force push to your fork. When you do a force push to your fork, the PR will be updated with your new changes, so there is no need to open a new PR to make changes. Leave a comment on the pull request thread to explain that the history has been changed. This will help to keep the commit history of the repository clean.
- Make sure your change does not break existing unit tests (see below for more details).
- After your pull request is merged please update the documentation if the changes require it:
- Edit appropriate [Wiki pages](https://github.com/JSC-electronics/ObjectButton/wiki).
- Edit appropriate [Wiki pages](https://github.com/JSC-TechMinds/ObjectButton/wiki).

## Testing the code
This library uses [Arduino CI](https://github.com/ianfixes/arduino_ci) as a unit test framework. When you create a pull request, your code will be tested against existing test cases. Sometimes it may be useful to test the code locally to save time. Please follow the instructions on Arduino CI page.
Expand All @@ -43,7 +43,7 @@ Requirements to build and run the unit tests:
### Setup
Clone ObjectButton git repository:
```bash
git clone git@github.com:JSC-electronics/ObjectButton.git
git clone git@github.com:JSC-TechMinds/ObjectButton.git
```

Install Ruby dependencies:
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# ObjectButton
[![Arduino_CI](https://github.com/JSC-electronics/ObjectButton/actions/workflows/arduino_ci.yml/badge.svg)](https://github.com/JSC-electronics/ObjectButton/actions/workflows/arduino_ci.yml)
[![Documentation](https://github.com/JSC-electronics/ObjectButton/actions/workflows/doxygen.yml/badge.svg)](https://github.com/JSC-electronics/ObjectButton/actions/workflows/doxygen.yml)
[![License: Apache 2.0](https://img.shields.io/badge/license-Apache--2.0-green.svg)](https://github.com/JSC-electronics/ObjectButton/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/JSC-electronics/ObjectButton.svg?maxAge=3600)](https://github.com/JSC-electronics/ObjectButton/releases)
[![JSC electronics](https://img.shields.io/badge/JSC-electronics-green.svg)](https://www.jsce.cz/)
[![Arduino_CI](https://github.com/JSC-TechMinds/ObjectButton/actions/workflows/arduino_ci.yml/badge.svg)](https://github.com/JSC-TechMinds/ObjectButton/actions/workflows/arduino_ci.yml)
[![Documentation](https://github.com/JSC-TechMinds/ObjectButton/actions/workflows/doxygen.yml/badge.svg)](https://github.com/JSC-TechMinds/ObjectButton/actions/workflows/doxygen.yml)
[![License: Apache 2.0](https://img.shields.io/badge/license-Apache--2.0-green.svg)](https://github.com/JSC-TechMinds/ObjectButton/blob/main/LICENSE)
[![GitHub release](https://img.shields.io/github/release/JSC-TechMinds/ObjectButton.svg?maxAge=3600)](https://github.com/JSC-TechMinds/ObjectButton/releases)
[![JSC TechMinds](https://img.shields.io/badge/JSC-TechMinds-green.svg)](https://www.jsctm.cz/)
[![Donate](https://img.shields.io/badge/donate-PayPal-blueviolet.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=SESX9ABM7V8KA&source=url)

ObjectButton is an Arduino library for detecting common button actions. Because of it, you can map different functions into a single button, i.e. turn on the light on a button click and play an alarm sound on double-click.
Expand Down Expand Up @@ -63,15 +63,15 @@ This library comes with reasonable defaults for detecting all the actions. Howev
## Contributing
There are many ways in which you can participate in the project, for example:

* [Submit bugs and feature requests](https://github.com/JSC-electronics/ObjectButton/issues), and help us verify as they are checked in
* Review [source code changes](https://github.com/JSC-electronics/ObjectButton/pulls)
* Review the [documentation](https://github.com/JSC-electronics/ObjectButton/wiki) and make pull requests for anything from typos to new content
* [Submit bugs and feature requests](https://github.com/JSC-TechMinds/ObjectButton/issues), and help us verify as they are checked in
* Review [source code changes](https://github.com/JSC-TechMinds/ObjectButton/pulls)
* Review the [documentation](https://github.com/JSC-TechMinds/ObjectButton/wiki) and make pull requests for anything from typos to new content

Please read [contributing rules](CONTRIBUTING.md) for more details.

## License

Copyright (c) JSC electronics. All rights reserved.
Copyright (c) JSC TechMinds. All rights reserved.

Licensed under the [Apache-2.0](LICENSE) license.

Expand All @@ -85,5 +85,5 @@ We hope our library helped to speed up your project development. You can support
[OneButton]: https://github.com/mathertel/OneButton
[so-object-member]: https://stackoverflow.com/questions/8865766/get-a-pointer-to-objects-member-function
[android-listener]: https://developer.android.com/reference/android/view/View.OnClickListener
[object-button-wiki]: https://github.com/JSC-electronics/ObjectButton/wiki
[object-button-doxygen]: https://jsc-electronics.github.io/ObjectButton
[object-button-wiki]: https://github.com/JSC-TechMinds/ObjectButton/wiki
[object-button-doxygen]: https://JSC-TechMinds.github.io/ObjectButton
2 changes: 1 addition & 1 deletion docs/ObjectButton_DoxygenMainPage.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* See the documentation of the main class, ObjectButton, or browse the modules
* and examples using the sidebar on the left.
*
* The latest development version is available on [GitHub](https://github.com/JSC-electronics/ObjectButton).
* The latest development version is available on [GitHub](https://github.com/JSC-TechMinds/ObjectButton).
*/

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
* This sketch demonstrates using ObjectButton library with single analog button,
* which will turn built-in LED on or off after being clicked.
*
* ObjectButton library: https://github.com/JSC-electronics/ObjectButton
* ObjectButton library: https://github.com/JSC-TechMinds/ObjectButton
*
* Copyright © JSC electronics
* Copyright © JSC TechMinds
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
* This sketch demonstrates using ObjectButton library with single analog sensor,
* which will turn built-in LED on or off after some motion is being detected.
*
* ObjectButton library: https://github.com/JSC-electronics/ObjectButton
* ObjectButton library: https://github.com/JSC-TechMinds/ObjectButton
*
* Copyright © JSC electronics
* Copyright © JSC TechMinds
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
4 changes: 2 additions & 2 deletions examples/BlinkMachine/BlinkMachine.ino
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
*
* See their sketch for more details on internal workings, if it's not clear for your from this code.
*
* ObjectButton library: https://github.com/JSC-electronics/ObjectButton
* ObjectButton library: https://github.com/JSC-TechMinds/ObjectButton
*
* Copyright © JSC electronics
* Copyright © JSC TechMinds
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@
* In this example, we'll show you, how to write your code, when you
* have class name conflicts.
*
* ObjectButton library: https://github.com/JSC-electronics/ObjectButton
* ObjectButton library: https://github.com/JSC-TechMinds/ObjectButton
*
* Copyright © JSC electronics
* Copyright © JSC TechMinds
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
4 changes: 2 additions & 2 deletions examples/InvertInputLogic/InvertInputLogic.ino
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
* In this example, however, the input logic can be also inverted during program execution.
* A long press of button 1 (INPUT_PIN_BUTTON1) inverts the logic of button 2 (INPUT_PIN_BUTTON2).
*
* ObjectButton library: https://github.com/JSC-electronics/ObjectButton
* ObjectButton library: https://github.com/JSC-TechMinds/ObjectButton
*
* Copyright © JSC electronics
* Copyright © JSC TechMinds
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
4 changes: 2 additions & 2 deletions examples/ToggleLedOnClick/ToggleLedOnClick.ino
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
* This sketch demonstrates using ObjectButton library with single digital button,
* which will turn built-in LED on or off after being clicked.
*
* ObjectButton library: https://github.com/JSC-electronics/ObjectButton
* ObjectButton library: https://github.com/JSC-TechMinds/ObjectButton
*
* Copyright © JSC electronics
* Copyright © JSC TechMinds
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
4 changes: 2 additions & 2 deletions examples/ToggleLedOnDoubleClick/ToggleLedOnDoubleClick.ino
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
* This sketch demonstrates using ObjectButton library with single digital button,
* which will turn built-in LED on or off after being double-clicked.
*
* ObjectButton library: https://github.com/JSC-electronics/ObjectButton
* ObjectButton library: https://github.com/JSC-TechMinds/ObjectButton
*
* Copyright © JSC electronics
* Copyright © JSC TechMinds
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
* This example is almost identical to ToggleLedOnDoubleClick.ino, except
* button state refresh is bound to interrupt.
*
* ObjectButton library: https://github.com/JSC-electronics/ObjectButton
* ObjectButton library: https://github.com/JSC-TechMinds/ObjectButton
*
* Copyright © JSC electronics
* Copyright © JSC TechMinds
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
4 changes: 2 additions & 2 deletions examples/TurnLedOnLongPress/TurnLedOnLongPress.ino
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
* This sketch demonstrates using ObjectButton library with single digital button,
* which will turn built-in LED on when it's long pressed.
*
* ObjectButton library: https://github.com/JSC-electronics/ObjectButton
* ObjectButton library: https://github.com/JSC-TechMinds/ObjectButton
*
* Copyright © JSC electronics
* Copyright © JSC TechMinds
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
* In this example we receive all events produced by buttons and print
* which event occurred on which button to the serial monitor.
*
* ObjectButton library: https://github.com/JSC-electronics/ObjectButton
* ObjectButton library: https://github.com/JSC-TechMinds/ObjectButton
*
* Copyright © JSC electronics
* Copyright © JSC TechMinds
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
*
* In this example we receive onClick() event, which simulates a motion detection.
*
* ObjectButton library: https://github.com/JSC-electronics/ObjectButton
* ObjectButton library: https://github.com/JSC-TechMinds/ObjectButton
*
* Copyright © JSC electronics
* Copyright © JSC TechMinds
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
4 changes: 2 additions & 2 deletions examples/TwoDigitalButtons/TwoDigitalButtons.ino
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
* In this example we receive all events produced by buttons and print
* which event occurred on which button to the serial monitor.
*
* ObjectButton library: https://github.com/JSC-electronics/ObjectButton
* ObjectButton library: https://github.com/JSC-TechMinds/ObjectButton
*
* Copyright © JSC electronics
* Copyright © JSC TechMinds
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
13 changes: 4 additions & 9 deletions library.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,15 @@
"repository":
{
"type": "git",
"url": "https://github.com/JSC-electronics/ObjectButton"
"url": "https://github.com/JSC-TechMinds/ObjectButton"
},
"authors":
[
{
"name": "Vladimír Záhradník",
"email": "vladimir.zahradnik@jsce.cz",
"url": "https://github.com/vzahradnik",
"name": "JSC TechMinds",
"email": "development@jsctm.cz",
"url": "https://github.com/JSC-TechMinds",
"maintainer": true
},
{
"name": "JSC electronics",
"email": "development@jsce.cz",
"url": "https://github.com/jsc-electronics"
}
],
"frameworks": "arduino",
Expand Down
6 changes: 3 additions & 3 deletions library.properties
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name=ObjectButton
version=2.0.0
author=JSC electronics
maintainer=Vladimír Záhradník <vladimir.zahradnik@jsce.cz>, JSC electronics <development@jsce.cz>
author=JSC TechMinds
maintainer=JSC TechMinds, development@jsctm.cz
sentence=An Arduino library for detecting button actions.
paragraph=ObjectButton is an Arduino library for detecting common button actions. Because of it, you can map different functions into a single button, i.e., turn on the light on a button click and play an alarm sound on double-click.
category=Signal Input/Output
url=https://github.com/JSC-electronics/ObjectButton
url=https://github.com/JSC-TechMinds/ObjectButton
architectures=*
license=Apache-2.0
6 changes: 3 additions & 3 deletions src/ObjectButton.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
* @file ObjectButton.h
* Project ObjectButton
* @brief An Arduino library for detecting button actions.
* @author Vladimír Záhradník
* License Apache-2.0 - Copyright (c) 2019-2020 JSC electronics
* @author JSC TechMinds
* License Apache-2.0 - Copyright (c) 2019-2024 JSC TechMinds
*
* @section License
*
* Copyright (c) 2019-2020 JSC electronics
* Copyright (c) 2019-2024 JSC TechMinds
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
8 changes: 5 additions & 3 deletions src/analog/AnalogButton.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@
* @file AnalogButton.cpp
* Project ObjectButton
* @brief An Arduino library for detecting button actions.
* @author Vladimír Záhradník
* License Apache-2.0 - Copyright (c) 2019-2020 JSC electronics
* @author JSC TechMinds
* License Apache-2.0 - Copyright (c) 2019-2024 JSC TechMinds
*
* Copyright (c) 2019-2020 JSC electronics
* @section License
*
* Copyright (c) 2019-2024 JSC TechMinds
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
6 changes: 3 additions & 3 deletions src/analog/AnalogButton.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
* @file AnalogButton.h
* Project ObjectButton
* @brief An Arduino library for detecting button actions.
* @author Vladimír Záhradník
* License Apache-2.0 - Copyright (c) 2019-2020 JSC electronics
* @author JSC TechMinds
* License Apache-2.0 - Copyright (c) 2019-2024 JSC TechMinds
*
* @section License
*
* Copyright (c) 2019-2020 JSC electronics
* Copyright (c) 2019-2024 JSC TechMinds
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
8 changes: 5 additions & 3 deletions src/analog/AnalogSensor.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@
* @file AnalogSensor.cpp
* Project ObjectButton
* @brief An Arduino library for detecting button actions.
* @author Vladimír Záhradník
* License Apache-2.0 - Copyright (c) 2019-2020 JSC electronics
* @author JSC TechMinds
* License Apache-2.0 - Copyright (c) 2019-2024 JSC TechMinds
*
* Copyright (c) 2019-2020 JSC electronics
* @section License
*
* Copyright (c) 2019-2024 JSC TechMinds
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down
Loading

0 comments on commit b6b9f03

Please sign in to comment.