Copyright etc

This commit is contained in:
2025-12-18 17:48:55 +11:00
parent d5f3d3ecbe
commit 3daf61d78a
5 changed files with 83 additions and 7 deletions

68
.gitignore vendored Normal file
View File

@@ -0,0 +1,68 @@
# PlatformIO
.pio
.pioenvs
.piolibdeps
.clang_complete
.gcc-flags.json
.ccls
compile_commands.json
# VSCode
.vscode/
!.vscode/extensions.json
.history/
# Build artifacts
*.o
*.a
*.hex
*.bin
*.elf
*.eep
*.lss
*.map
*.sym
# OS
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db
*~
# IDEs
*.swp
*.swo
.idea/
*.sublime-project
*.sublime-workspace
.atom/
# Temporary files
*.tmp
*.bak
*.log
*~.nib
local.properties
# Arduino
*.ino.cpp
*.ino.hex
*.ino.elf
*.ino.eep
*.ino.map
# Dependencies
node_modules/
bower_components/
# Python (if using scripts)
__pycache__/
*.py[cod]
*.egg-info/
.Python
venv/
env/

View File

@@ -35,13 +35,13 @@ Why another library? Most of the Victron BLE examples are built into other frame
1. Add to `platformio.ini`:
```ini
lib_deps =
https://github.com/yourusername/VictronBLE.git
https://gitea.sh3d.com.au/Sh3d/VictronBLE
```
2. Or clone into your project's `lib` folder:
```bash
cd lib
git clone https://github.com/yourusername/VictronBLE.git
git clone https://gitea.sh3d.com.au/Sh3d/VictronBLE
```
### Arduino IDE
@@ -432,6 +432,11 @@ This library was inspired by and builds upon excellent prior work:
MIT License - see LICENSE file for details
Copyright (c) 2025 Scott Penrose <scottp@dd.com.au>
* https://www.sh3d.com.au/ - Sh3d
* https://www.dd.com.au/ - Digital Dimensions
## Disclaimer
This library is not officially supported by Victron Energy. Use at your own risk.

View File

@@ -1,11 +1,11 @@
name=VictronBLE
version=1.0.0
author=VictronBLE Contributors
maintainer=Your Name <your.email@example.com>
sentence=ESP32 library for reading Victron Energy device data via BLE
author=Scott Penrose
maintainer=Scott Penrose <scottp@dd.com.au>
sentence=ESP32 library for reading Victron Energy device data via BLE for any ESP32
paragraph=Read data from Victron SmartSolar, SmartShunt, BMV, inverters and other devices using Bluetooth Low Energy advertisements. Supports multiple devices simultaneously with no pairing required.
category=Communication
url=https://github.com/yourusername/VictronBLE
url=https://gitea.sh3d.com.au/Sh3d/VictronBLE
architectures=esp32
depends=
includes=VictronBLE.h

View File

@@ -1,6 +1,9 @@
/**
* VictronBLE - ESP32 library for Victron Energy BLE devices
* Implementation file
*
* Copyright (c) 2025 Scott Penrose
* License: MIT
*/
#include "VictronBLE.h"

View File

@@ -4,7 +4,7 @@
* Based on Victron's official BLE Advertising protocol documentation
* Inspired by hoberman's examples and keshavdv's Python library
*
* Copyright (c) 2024
* Copyright (c) 2025 Scott Penrose
* License: MIT
*/