Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v3.0.0 #778

Merged
merged 4 commits into from
Oct 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 3.0.0-beta.6
current_version = 3.0.0
commit = True
tag = False
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z\.\d]+))?
Expand Down
2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = SensESP
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 3.0.0-beta.6
PROJECT_NUMBER = 3.0.0

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down
110 changes: 55 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,60 @@
# SensESP

## Introduction

**TL;DR: [Click here for the Getting Started documentation!](https://signalk.org/SensESP/pages/getting_started/)**

SensESP is a [Signal K](https://signalk.org) sensor development toolkit for the [ESP32](https://en.wikipedia.org/wiki/ESP32) platform.
If you are a boater (or a professional developer!) who wants to build a custom Wi-Fi connected sensor for your boat, this is the toolkit you need.
SensESP runs on commonly available ESP32 boards and helps you get sensor readings from physical sensors and transform them to meaningful data for Signal K or other outputs.

SensESP is built on the [Arduino](https://github.com/espressif/arduino-esp32) software development framework, a popular open source platform for embedded development.
(Note that this refers only to the software stack - Arduino hardware is not supported.)
To automate the management of external libraries, it also heavily relies on PlatformIO, a cross-platform build system for embedded devices (in other words, Arduino IDE is not supported).

SensESP features include:

* High-level programming interfaces for sensor development
* Support for a wide range of common sensor hardware with a set of [add-on libraries](https://signalk.org/SensESP/pages/additional_resources/) - and if native support is missing, using existing Arduino libraries directly is also quite simple in most cases
* A Web configuration user interface for sensors, transforms, and output paths
* Easy on-boarding with a Wi-Fi configuration tool and fully automated server discovery
* Full Signal K integration with authentication, and transmission and reception of data
* Support for over-the-air (OTA) firmware updates
* Support for remote debugging over Wi-Fi

To use SensESP, you need an ESP32 development board and a way to power it from the boat's 12V or 24V nominal power system.
This can be done with commonly available ESP32DevKit boards and external DC-DC converters, or alternatively, the [Sailor Hat with ESP32 (SH-ESP32)](https://hatlabs.fi/product/sailor-hat-with-esp32/) has all these features baked into a developer-friendly board and enclosure kit.

Example use cases of SensESP include:

* Engine temperature measurement
* Switch input for bilge alarms
* Device control using relays
* Custom GPS and attitude sensors
* Engine RPM measurement
* Anchor chain counter
* Battery voltage and current measurement
* Tank level measurement
* Custom NMEA 2000 sensors

At heart, SensESP is a development toolkit, and not ready-made software.
This means that you will need to do some simple programming to use it.
Don't worry, though.
The project is newbie-friendly, so you don't need to know much to get started.
A lot of examples and tutorials are provided, and some related projects also provide ready-to-use firmware for specific use cases.

## Documentation

To get started, [see the project documentation](https://signalk.org/SensESP/).

For reference, the old SensESP version 1 documentation is still available at the [repository wiki](https://github.com/SignalK/SensESP/wiki).

## Getting help

Discussion about SensESP happens mostly on the [Signal K Discord](https://discord.com/channels/1170433917761892493/1170433918592368684) on the #sensesp channel. To register as a new user, follow the invite link at [signalk.org](https://signalk.org/).

Another place for SensESP discussions is the [discussion board on the SensESP GitHub repository](https://github.com/SignalK/SensESP/discussions).

## Getting Started with Version 3

### Major Changes
Expand Down Expand Up @@ -180,58 +235,3 @@ To start the development server, run:
cd frontend
pnpm run dev
```

## Introduction

**TL;DR: [Click here for the Getting Started documentation!](https://signalk.org/SensESP/pages/getting_started/)**

SensESP is a [Signal K](https://signalk.org) sensor development toolkit for the [ESP32](https://en.wikipedia.org/wiki/ESP32) platform.
If you are a boater (or a professional developer!) who wants to build a custom Wi-Fi connected sensor for your boat, this is the toolkit you need.
SensESP runs on commonly available ESP32 boards and helps you get sensor readings from physical sensors and transform them to meaningful data for Signal K or other outputs.

SensESP is built on the [Arduino](https://github.com/espressif/arduino-esp32) software development framework, a popular open source platform for embedded development.
(Note that this refers only to the software stack - Arduino hardware is not supported.)
To automate the management of external libraries, it also heavily relies on PlatformIO, a cross-platform build system for embedded devices (in other words, Arduino IDE is not supported).

SensESP features include:

* High-level programming interfaces for sensor development
* Support for a wide range of common sensor hardware with a set of [add-on libraries](https://signalk.org/SensESP/pages/additional_resources/) - and if native support is missing, using existing Arduino libraries directly is also quite simple in most cases
* A Web configuration user interface for sensors, transforms, and output paths
* Easy on-boarding with a Wi-Fi configuration tool and fully automated server discovery
* Full Signal K integration with authentication, and transmission and reception of data
* Support for over-the-air (OTA) firmware updates
* Support for remote debugging over Wi-Fi

To use SensESP, you need an ESP32 development board and a way to power it from the boat's 12V or 24V nominal power system.
This can be done with commonly available ESP32DevKit boards and external DC-DC converters, or alternatively, the [Sailor Hat with ESP32 (SH-ESP32)](https://hatlabs.fi/product/sailor-hat-with-esp32/) has all these features baked into a developer-friendly board and enclosure kit.

Example use cases of SensESP include:

* Engine temperature measurement
* Switch input for bilge alarms
* Device control using relays
* Custom GPS and attitude sensors
* Engine RPM measurement
* Anchor chain counter
* Battery voltage and current measurement
* Tank level measurement
* Custom NMEA 2000 sensors

At heart, SensESP is a development toolkit, and not ready-made software.
This means that you will need to do some simple programming to use it.
Don't worry, though.
The project is newbie-friendly, so you don't need to know much to get started.
A lot of examples and tutorials are provided, and some related projects also provide ready-to-use firmware for specific use cases.

## Documentation

To get started, [see the project documentation](https://signalk.org/SensESP/).

For reference, the old SensESP version 1 documentation is still available at the [repository wiki](https://github.com/SignalK/SensESP/wiki).

## Getting help

Discussion about SensESP happens mostly on the [Signal K Discord](https://discord.com/channels/1170433917761892493/1170433918592368684) on the #sensesp channel. To register as a new user, follow the invite link at [signalk.org](https://signalk.org/).

Another place for SensESP discussions is the [discussion board on the SensESP GitHub repository](https://github.com/SignalK/SensESP/discussions).
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.0.0-beta.6
3.0.0
2 changes: 1 addition & 1 deletion docs/generated/docs/air__density_8cpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/air__density_8cpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/air__density_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/air__density_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/analog__input_8cpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/analog__input_8cpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/analog__input_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/analog__input_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/analog__reader_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/analog__reader_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/analogvoltage_8cpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/analogvoltage_8cpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/analogvoltage_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/analogvoltage_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/angle__correction_8cpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/angle__correction_8cpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/angle__correction_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/angle__correction_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/app__command__handler_8cpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/app__command__handler_8cpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/app__command__handler_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/app__command__handler_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/async__response__handler_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/base__button_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/base__button_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/docs/base__command__handler_8cpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0-beta.6</span>
<div id="projectname">SensESP<span id="projectnumber">&#160;3.0.0</span>
</div>
<div id="projectbrief">Universal Signal K sensor toolkit ESP32</div>
</td>
Expand Down
Loading
Loading