Commit Graph

108 Commits

Author SHA1 Message Date
Matthias Wirtz
f3dc81480d docs: fix and rearrange screenshot links (alphabetical) (#4580)
* fix and rearrange links (alphabetical) - add missing ones

* update screenshots

* add info about screenshots to contribution guideline.
2025-03-24 09:21:58 +01:00
Juan Carlos Heredia
0b72b89ed4 Update readme file with new dashboard (#4579) 2025-03-09 13:45:52 +01:00
Jakob Lichterfeld
1972584d8f style(docs): fix line length fenced-code-style, no bare url links, multiple whitespaces, alt text, header style 2025-02-23 14:20:57 +01:00
JakobLichterfeld
fdf8185ce2 ci: add treefmt as code formatting multiplexer, refactor CI to avoid duplication, reorg CI into DevOps workflow (#4219)
* ci: add treefmt as code formatting multiplexer

* style: linter findings in entrypoint.sh script

* style: linter findings for yaml and yml

* style: linter findings for json files

* style: linter findings for nix files

* style: linter findings for js files

* style: linter findings for dashboards.sh

* style: linter findings for md and mdx files

* chore: remove unused clang formatter in treefmt config

* style: linter findings for mdx files

* ci: exclude Grafana dashboard JSON files from prettier formatting

* Revert "style: linter findings for json files"

This reverts commit f40c2e175992f66f887a3f4fc5aa1a1a89393147.

* ci: exclude Grafana dashboard JSON files from all formatting as we use the grafana export style

* style: linter findings for json files

* doc: update changelog

* ci(refactor): use composite action to avoid duplication in elixir workflow

* doc: update changelog

* ci: prevent workflow runs for certain conditions and allow scheduled runs

* ci(refactor): use reusable workflow to check paths

* ci(fix): correct output syntax for check_paths workflow and setting base branch

* ci(refactor): use reusable workflows for streamlined DevOps pipeline

* ci(fix): add write permission for packages in DevOps workflow

* ci(test): test DevOps workflow

* ci(test): test DevOps workflow

* ci(fix): Update condition for spell_check, ensure_linting, elixir, and ghcr_build workflows to reflect empty result instead of false

* ci: revert test DevOps

* ci(refactor): allow ghcr_build parallel to elixir test

* ci(refactor): Remove redundant check_paths job from elixir.yml, elixir_test.yml, and spell_check.yml workflows, check is done in devops.yml

* feat: add treefmt-nix to nix flake (#4219 - @JakobLichterfeld)

* ci: ensure proper linting via treefmt

* ci(test): test ensure_linting workflow

* ci(fix): checkout code for spell_checker to access file to check

* ci(fix): allow impure in ensure_linting workflow

* Revert "ci(test): test ensure_linting workflow"

This reverts commit a67b17ec098a628a8b093ec20b34b0e2696811cc.

* ci(fix): correct use of flake-utils for formatter and checks

Co-authored-by: scottbot95 <scottbot95@gmail.com>

* ci(fix): correct use of flake-utils for treefmt

Co-authored-by: scottbot95 <scottbot95@gmail.com>

* refactor: Remove unnecessary imports in flake

* ci(fix): correct syntax in flake

* ci(refactor): Remove unused code in flake.nix

* style: standardised style for input url in flake

* ci(fix): treefmt-nix config with existing options

* ci(feat): Add Nix binary cache and update treefmt command in CI workflow

* ci(refactor): Remove unused code in flake.nix

* fix: include devShell packages only on supported platforms

* fix: update hash for mix-deps package in flake.nix

* ci(fix): Update treefmt command in CI workflow

* ci(test): test ensure_linting workflow

* feat: ensure mix deps are present in devShell

* ci(feat): use flake-parts to enable treefmt-nix

* feat: use flake-parts

* fix: correct use of flake-parts for package build

* doc: update CI badge URL for devops workflow

* ci(fix): handle empty path filter output

* ci: remove --impure flag from treefmt command in CI workflow

* fix: correct treefmt.config settings in formatter.nix

* fix: correct flake-parts inputs, avoid with in imports

* fix: correct program name for mix-format in formatter.nix

* feat: devenv via flake-parts

* fix: correct use of legacy nix code with flake-parts

* ci(fix): correct nix develop command in ensure_linting.yml

* refactor: list imports explicitly in flake, rename folder to flake-modules to be precise

* style: use tabs for indent size to format sh

* style: use nixfmt-rfc-style

* Revert "style: use nixfmt-rfc-style"

This reverts commit 082056159e611c2c0639f8b4dc509446f5308a92.

* style: use nixfmt style

* fix: remove glibcLocales from optional dependencies to avoid  "A definition for option `packages."[definition 4-entry 16]"' is not of type `package'."

* fix: remove inotify-tools from optional dependencies to avoid  "A definition for option `packages."[definition 4-entry 16]"' is not of type `package'."

* fix: Remove inotify-tools and glibcLocales from optional dependencie

* fix: correct file paths in flake.nix to version

* fix: add ELIXIR_ERL_OPTIONS to shell environment to force utf8 locale

* fix: add LOCALE_ARCHIVE to shell environment in flake.nix

* Revert "fix: add LOCALE_ARCHIVE to shell environment in flake.nix"

This reverts commit d45f6e32eea1fcaf55cd03733e648cda4dbb764b.

* ci(refactor): rename workflow to elixir_dep_verification_and_static_analysis.yml to better reflect the intention,, remove duplicate checks

* ci(debug): debug locale settings

* Revert "ci(debug): debug locale settings"

This reverts commit 9b402f3c5f9b41ff4716dc4fc99f711fc9ef8135.

* Revert "fix: add ELIXIR_ERL_OPTIONS to shell environment to force utf8 locale"

This reverts commit d02419cba44055d55978ad36d23493d8790ce21b.

* fix: add LOCALE_ARCHIVE to shell environment in flake.nix

* Revert "fix: add LOCALE_ARCHIVE to shell environment in flake.nix"

This reverts commit 761b437e699d8381a0726dd969052b1e85c3f08f.

* fix: add LANG=C.UTF-8 to shell environment in flake.nix

* fix: add mix local.rebar and mix local.hex commands to flake.nix

* fix: pin devenv to version without unix socket bug

* chore: update nixpkgs to nixos-24.05 and update dependencies

* doc: add treefmt config comments

* ci: do not expose treefmt formatter programs in devshell

* fix: correct use of module option to enable PostgreSQL server in flake.nix

* Revert "chore: update nixpkgs to nixos-24.05 and update dependencies"

This reverts commit a6ea3f25aa393c32d9c2494b21e6330de2482496.

* feat: consistent use of erlang 26 and elixir 1_16 in flake

* ci: switch to macOS runner for linting workflow

* Revert "ci: do not expose treefmt formatter programs in devshell"

This reverts commit 1ecfa451dcf4199554a5d96d241ee846601862d9.

* Revert "ci: switch to macOS runner for linting workflow"

This reverts commit 7b430667d8737e5adf91f5ba59bbf83eb15bcb7a.

* ci: Remove nixpkgs channel specification in ensure_linting workflow

* ci(debug): Add debug output for PATH and NIX_PATH in flake.nix

* Revert "ci(debug): Add debug output for PATH and NIX_PATH in flake.nix"

This reverts commit 07faec5ddf88195969f89f3e74791d030c980b03.

* fix: avoid the need for impure for devenv

see #4245

* fix: remove invalid custom build.check for formatter and use default

* style: linter findings

* fix: Add emptyTest to avoid nix flake check test execution on non-Linux systems

* chore: Remove LANG=C.UTF-8 from enterShell in flake.nix

* ci(fix): Remove --impure flag from treefmt command in CI mode

* ci(fix): avoid impure mode in ensure_linting workflow

* style: linter findings

* ci(debug): debug elixir version and locale

* chore: Update flake.lock dependencies

* feat: use newer devenv as unix socket bug is fixed in upstream

https://github.com/cachix/devenv/issues/1497

* fix: set rebar3 path in devenv

* Revert "ci(debug): debug elixir version and locale"

This reverts commit 7ecdc77c163cd6ef9c913689c1f75e86ce8587cb.

* ci: re-enable path check in DevOps workflow

* doc: update Development and Contributing guide with nix and treefmt

* ci: use PostgreSQL 17

* style: linter findings

* ci(fix): ensure cache name in build action does not contain invalid characters to avoid invalid reference format

* doc: update changelog

* Revert "ci(fix): ensure cache name in build action does not contain invalid characters to avoid invalid reference format"

This reverts commit 02abb0359db4f22e5a28283476b3ced0d99729ff.

* ci: remove branch restriction for check_paths workflow to increase sec

* ci(fix): run ghcr build workflow only for specific conditions

- Ensure workflow only run if there are no changes to the .github folder
- Allow workflow to run on workflow call or PRs from forks
- Prevent duplicate runs for PRs from non-forks
- Avoid invalid reference format for cache name in PRs from our repository

* doc: update changelog

* fix: update hash for mix-deps package in flake.nix

* fix: disable flakeCheck for formatter, as mix format need the dep to be fetched beforehand

* ci(fix): run ghcr build workflow only for specific conditions

* fix: move nixosModules.default to top-level attribute set

* refactor: remove unnecessary config nesting in formatter.nix

* ci(fix): ensure version for buildx is set to correct name

---------

Co-authored-by: scottbot95 <scottbot95@gmail.com>
2024-10-14 08:54:10 +02:00
JakobLichterfeld
97b5bfcb1a doc: Add initial author and list of contributors to README.md (#4084)
* doc: Add initial author and list of contributors to README.md

* doc: update changelog
2024-07-15 10:00:29 +02:00
Juan Carlos Heredia
27a6a7eb7e Improve visualizations on Battery Health dasboard (#4005)
* Updata labels and data

* Update screenshot

* Update Readme

* Update drive screenshot
2024-06-28 09:57:58 +02:00
Juan Carlos Heredia
f4fdedb2d7 Improve Battery health derived efficiency estimations and Fix error divided by zero (#3593)
* Improve Battery health derived efficiency estimations and Fix error divided by zero

* Fix unit convert

* Update screenshot

* Keep iteration value

* Remove name mention.
2024-01-19 15:38:46 +01:00
Adrian Kumpf
9df62aee54 Update repo URL 2023-11-12 19:30:36 +01:00
Adrian Kumpf
b545eaf8f4 Remove donation links 2023-11-12 19:26:52 +01:00
Juan Carlos Heredia
01d3e78a74 Updated readme, docs and Spanish translation (#3244)
* Updated readme docs and spanish translations

* Improve query to avoid nulls on cars with no long charging sessions

* Revert "Improve query to avoid nulls on cars with no long charging sessions"

This reverts commit 5dc1a74e1ceb70028b8afe4e3cc0cb5d10cf89c0.
2023-11-12 18:10:46 +01:00
Adrian Kumpf
897c6eb826 Add Docker status badge 2023-06-11 01:40:48 +02:00
Adrian Kumpf
799a40796c Update CI status badge 2023-06-11 01:38:58 +02:00
Adrian Kumpf
0b117792bc Remove badges from MicroBadger
MicroBadger.com shutdown on 1st July 2021
2021-07-09 14:51:22 +02:00
Tobias Lindberg
b2dad66d99 Translations, docs typo and other badges (#1461)
* adding swedish translation string for token related things

* typo in docs FAQ page

* switching microbadger images to shields.io
2021-03-18 11:48:57 +01:00
Adrian Kumpf
396e7f9a39 Add GitHub action 2020-07-09 20:35:32 +02:00
Adrian Kumpf
a694651fb5 Update README 2020-04-16 11:21:55 +02:00
Adrian Kumpf
c6b265788c Migrate docs to docusaurus
Fixes #564
2020-04-07 19:32:18 +02:00
Adrian Kumpf
71a018d54d Update README 2020-03-27 11:34:02 +01:00
Adrian Kumpf
fb35e3ec7e Add link to the tesla-apiscraper import docs 2020-02-16 12:45:45 +01:00
Adrian Kumpf
59295ce8cf Update docs 2020-02-10 15:56:45 +01:00
Adrian Kumpf
b13ade0cac 1.16.0 2020-02-07 14:27:09 +01:00
Adrian Kumpf
f61315cb10 Implement TeslaFi import
Closes #316
2020-02-07 13:21:05 +01:00
Adrian Kumpf
74a612c1f2 Fix typo 2020-01-24 14:08:47 +01:00
Adrian Kumpf
8bd5c4b29d 1.15.0 2020-01-23 15:06:48 +01:00
Adrian Kumpf
d13ca4d7f7 Document how to update postgres 2020-01-23 12:44:57 +01:00
Adrian Kumpf
a2c5a7991c Document how a drive can be deleted manually
Closes #360
2020-01-21 17:16:32 +01:00
Adrian Kumpf
3399476949 Update toc 2020-01-15 20:08:48 +01:00
Adrian Kumpf
7c1702d471 Fix typo 2020-01-04 17:08:03 +01:00
Adrian Kumpf
e7fe6a4695 Update readme 2019-12-22 19:07:59 +01:00
Adrian Kumpf
7a25192c6d Re-add link to helm chart 2019-12-22 19:04:40 +01:00
Adrian Kumpf
a680724ec0 Update TOC 2019-12-22 18:54:56 +01:00
Adrian Kumpf
6d8e96c3f5 Use 'latest' badge 2019-12-22 18:39:59 +01:00
John Barker
12fa8c2d93 Direct people to new RTD site
* Add Shield Badge
* Ensure anyone going into `/docs` is directed to RTD
2019-12-22 18:39:59 +01:00
John Barker
29fa9c18fe ReadTheDocs (RTD) support
TeslaMate has a large amount of documentation that end-users may not be
away of. By using RTD we can have a full docsite with hierarchy
navigation structure to help improve discoverability.

I've broken the docs into these sections:
* Getting Started
* Sleep configuration
* Integrations
* Advanced configuration
* Development and Contribution

* Basic readthedocs/Sphinx support
  * sphinx-markdown-tables for the table of environment variables
    * `docs/conf.py` only minimal config needed.
    * new `docs/index.rst` which is the root page, note that is is RST
    * (ReStructured Text), not markdown. This file is also used to
    * generate the left navigation bar.
    * Use native markdown for images (inline HTML didn't work)
    * Edit on GitHub link on the top right of every page, hopefully,
    * makes it easier for Contributors
2019-12-22 17:12:02 +01:00
Adrian Kumpf
aee0919b59 Update sleep mode docs 2019-12-16 10:42:19 +01:00
Adrian Kumpf
baf3863b39 Fix broken links 2019-12-02 19:57:20 +01:00
John Barker
d8982a3cd4 Various small docs improvements 2019-12-02 19:54:33 +01:00
Adrian Kumpf
69b7c96284 Bump version to 1.13.1 2019-11-26 17:41:55 +01:00
Adrian Kumpf
a96dedad11 Add "car in service" state
Resolves #217
2019-10-24 22:48:08 +02:00
Adrian Kumpf
f2769869d6 Tweak calculation of charge energy used 2019-10-24 15:57:29 +02:00
Adrian Kumpf
5eebacfb9b Add restart policy to recommended docker setup 2019-10-23 22:46:28 +02:00
Adrian Kumpf
c54bf14ed7 Update docs 2019-10-22 20:04:24 +02:00
Adrian Kumpf
8c9e712999 Fix typos 2019-10-21 22:14:27 +02:00
Adrian Kumpf
dd5c2d7934 Update docs 2019-10-21 15:07:16 +02:00
Adrian Kumpf
5dff59a7bf Indicate when a (car) software update is available 2019-10-19 16:29:35 +02:00
Adrian Kumpf
dca44e141f Use preferred range for efficiency calculation 2019-10-17 20:45:03 +02:00
Adrian Kumpf
abfa8c96d5 Device efficiency factor from charge data 2019-10-16 21:12:53 +02:00
Adrian Kumpf
25133e231b Bump version 2019-10-12 13:06:35 +02:00
Adrian Kumpf
fedfcbdc28 Publish software version via MQTT 2019-10-12 12:31:08 +02:00
Adrian Kumpf
7ac8d56812 Make :check_origin configurable via env variable
Resolved #194
2019-10-06 13:58:12 +02:00