ekos-notifier 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (133) hide show
  1. ekos_notifier-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml +27 -0
  2. ekos_notifier-0.1.0/.github/ISSUE_TEMPLATE/device_support.yml +21 -0
  3. ekos_notifier-0.1.0/.github/workflows/ci.yml +42 -0
  4. ekos_notifier-0.1.0/.github/workflows/release.yml +74 -0
  5. ekos_notifier-0.1.0/.gitignore +235 -0
  6. ekos_notifier-0.1.0/CHANGELOG.md +234 -0
  7. ekos_notifier-0.1.0/CLAUDE.md +79 -0
  8. ekos_notifier-0.1.0/CONTRIBUTING.md +46 -0
  9. ekos_notifier-0.1.0/LICENSE +21 -0
  10. ekos_notifier-0.1.0/PKG-INFO +349 -0
  11. ekos_notifier-0.1.0/README.md +324 -0
  12. ekos_notifier-0.1.0/config.example.yaml +109 -0
  13. ekos_notifier-0.1.0/docs/design.md +460 -0
  14. ekos_notifier-0.1.0/docs/index.md +210 -0
  15. ekos_notifier-0.1.0/docs/open-questions.md +323 -0
  16. ekos_notifier-0.1.0/install.sh +178 -0
  17. ekos_notifier-0.1.0/mkdocs.yml +12 -0
  18. ekos_notifier-0.1.0/pyproject.toml +51 -0
  19. ekos_notifier-0.1.0/src/ekos_notifier/__init__.py +3 -0
  20. ekos_notifier-0.1.0/src/ekos_notifier/__main__.py +5 -0
  21. ekos_notifier-0.1.0/src/ekos_notifier/alerts.py +86 -0
  22. ekos_notifier-0.1.0/src/ekos_notifier/align.py +135 -0
  23. ekos_notifier-0.1.0/src/ekos_notifier/calibration.py +92 -0
  24. ekos_notifier-0.1.0/src/ekos_notifier/capture.py +186 -0
  25. ekos_notifier-0.1.0/src/ekos_notifier/cli.py +463 -0
  26. ekos_notifier-0.1.0/src/ekos_notifier/clouds.py +246 -0
  27. ekos_notifier-0.1.0/src/ekos_notifier/conditions.py +396 -0
  28. ekos_notifier-0.1.0/src/ekos_notifier/config.py +209 -0
  29. ekos_notifier-0.1.0/src/ekos_notifier/digest.py +371 -0
  30. ekos_notifier-0.1.0/src/ekos_notifier/disk.py +139 -0
  31. ekos_notifier-0.1.0/src/ekos_notifier/ekos/__init__.py +1 -0
  32. ekos_notifier-0.1.0/src/ekos_notifier/ekos/adapter.py +357 -0
  33. ekos_notifier-0.1.0/src/ekos_notifier/ekos/bus.py +82 -0
  34. ekos_notifier-0.1.0/src/ekos_notifier/ekos/decode.py +154 -0
  35. ekos_notifier-0.1.0/src/ekos_notifier/ekos/settings.py +261 -0
  36. ekos_notifier-0.1.0/src/ekos_notifier/ekos/states.py +140 -0
  37. ekos_notifier-0.1.0/src/ekos_notifier/ephemeris.py +127 -0
  38. ekos_notifier-0.1.0/src/ekos_notifier/events.py +22 -0
  39. ekos_notifier-0.1.0/src/ekos_notifier/focus.py +87 -0
  40. ekos_notifier-0.1.0/src/ekos_notifier/guiding.py +516 -0
  41. ekos_notifier-0.1.0/src/ekos_notifier/indi/__init__.py +2 -0
  42. ekos_notifier-0.1.0/src/ekos_notifier/indi/adapter.py +151 -0
  43. ekos_notifier-0.1.0/src/ekos_notifier/indi/decode.py +401 -0
  44. ekos_notifier-0.1.0/src/ekos_notifier/indi/dump.py +119 -0
  45. ekos_notifier-0.1.0/src/ekos_notifier/indi/presets/camera-standard.yaml +8 -0
  46. ekos_notifier-0.1.0/src/ekos_notifier/indi/presets/focuser-standard.yaml +8 -0
  47. ekos_notifier-0.1.0/src/ekos_notifier/indi/presets/power-standard.yaml +13 -0
  48. ekos_notifier-0.1.0/src/ekos_notifier/indi/presets/weather-standard.yaml +12 -0
  49. ekos_notifier-0.1.0/src/ekos_notifier/indi/presets.py +92 -0
  50. ekos_notifier-0.1.0/src/ekos_notifier/legacy.py +65 -0
  51. ekos_notifier-0.1.0/src/ekos_notifier/lock.py +60 -0
  52. ekos_notifier-0.1.0/src/ekos_notifier/messages.py +180 -0
  53. ekos_notifier-0.1.0/src/ekos_notifier/notify.py +236 -0
  54. ekos_notifier-0.1.0/src/ekos_notifier/phd2/__init__.py +1 -0
  55. ekos_notifier-0.1.0/src/ekos_notifier/phd2/adapter.py +163 -0
  56. ekos_notifier-0.1.0/src/ekos_notifier/phd2/decode.py +185 -0
  57. ekos_notifier-0.1.0/src/ekos_notifier/pipeline.py +85 -0
  58. ekos_notifier-0.1.0/src/ekos_notifier/power.py +316 -0
  59. ekos_notifier-0.1.0/src/ekos_notifier/reload.py +85 -0
  60. ekos_notifier-0.1.0/src/ekos_notifier/replay.py +80 -0
  61. ekos_notifier-0.1.0/src/ekos_notifier/rules.py +406 -0
  62. ekos_notifier-0.1.0/src/ekos_notifier/samples/__init__.py +17 -0
  63. ekos_notifier-0.1.0/src/ekos_notifier/samples/sim-m31-scheduler-kstars-3.8.5-flatpak.ndjson.gz +0 -0
  64. ekos_notifier-0.1.0/src/ekos_notifier/service.py +231 -0
  65. ekos_notifier-0.1.0/src/ekos_notifier/session.py +265 -0
  66. ekos_notifier-0.1.0/src/ekos_notifier/simulate.py +187 -0
  67. ekos_notifier-0.1.0/src/ekos_notifier/sky.py +320 -0
  68. ekos_notifier-0.1.0/src/ekos_notifier/stats.py +117 -0
  69. ekos_notifier-0.1.0/src/ekos_notifier/store.py +471 -0
  70. ekos_notifier-0.1.0/src/ekos_notifier/systemd.py +118 -0
  71. ekos_notifier-0.1.0/tests/conftest.py +11 -0
  72. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars.xml +370 -0
  73. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_Ekos.xml +157 -0
  74. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_Ekos_Align.xml +120 -0
  75. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_Ekos_Capture.xml +204 -0
  76. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_Ekos_Focus.xml +145 -0
  77. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_Ekos_Guide.xml +123 -0
  78. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_Ekos_Mount.xml +121 -0
  79. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_Ekos_Observatory.xml +50 -0
  80. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_Ekos_OpticalTrain.xml +17 -0
  81. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_Ekos_OpticalTrain_2.xml +101 -0
  82. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_Ekos_Scheduler.xml +79 -0
  83. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_INDI.xml +144 -0
  84. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_INDI_GenericDevice.xml +21 -0
  85. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_INDI_GenericDevice_1.xml +54 -0
  86. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_INDI_GenericDevice_2.xml +54 -0
  87. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_INDI_GenericDevice_3.xml +54 -0
  88. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_INDI_GenericDevice_4.xml +54 -0
  89. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_INDI_GenericDevice_5.xml +54 -0
  90. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_INDI_Weather.xml +17 -0
  91. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_INDI_Weather_1.xml +62 -0
  92. ekos_notifier-0.1.0/tests/fixtures/dbus/kstars-3.8.5-flatpak/KStars_SimClock.xml +54 -0
  93. ekos_notifier-0.1.0/tests/fixtures/indi/ccd-simulator-cooling-libindi-2.2.5.xml.gz +0 -0
  94. ekos_notifier-0.1.0/tests/fixtures/indi/power-simulator-libindi-2.2.5.xml.gz +0 -0
  95. ekos_notifier-0.1.0/tests/fixtures/indi/weather-simulator-humidity-libindi-2.2.5.xml.gz +0 -0
  96. ekos_notifier-0.1.0/tests/fixtures/replay/README.md +65 -0
  97. ekos_notifier-0.1.0/tests/test_align.py +103 -0
  98. ekos_notifier-0.1.0/tests/test_calibration.py +97 -0
  99. ekos_notifier-0.1.0/tests/test_capture_alerts.py +368 -0
  100. ekos_notifier-0.1.0/tests/test_cli.py +79 -0
  101. ekos_notifier-0.1.0/tests/test_clouds.py +131 -0
  102. ekos_notifier-0.1.0/tests/test_conditions.py +250 -0
  103. ekos_notifier-0.1.0/tests/test_config_init.py +37 -0
  104. ekos_notifier-0.1.0/tests/test_digest.py +232 -0
  105. ekos_notifier-0.1.0/tests/test_disk_flip.py +178 -0
  106. ekos_notifier-0.1.0/tests/test_ekos_adapter.py +193 -0
  107. ekos_notifier-0.1.0/tests/test_ekos_bus.py +40 -0
  108. ekos_notifier-0.1.0/tests/test_ekos_decode.py +106 -0
  109. ekos_notifier-0.1.0/tests/test_ekos_settings.py +128 -0
  110. ekos_notifier-0.1.0/tests/test_guiding.py +334 -0
  111. ekos_notifier-0.1.0/tests/test_hardening.py +123 -0
  112. ekos_notifier-0.1.0/tests/test_indi.py +315 -0
  113. ekos_notifier-0.1.0/tests/test_install_service.py +126 -0
  114. ekos_notifier-0.1.0/tests/test_legacy.py +54 -0
  115. ekos_notifier-0.1.0/tests/test_messages.py +183 -0
  116. ekos_notifier-0.1.0/tests/test_notify.py +196 -0
  117. ekos_notifier-0.1.0/tests/test_phd2.py +293 -0
  118. ekos_notifier-0.1.0/tests/test_power.py +312 -0
  119. ekos_notifier-0.1.0/tests/test_preflight.py +98 -0
  120. ekos_notifier-0.1.0/tests/test_reload.py +168 -0
  121. ekos_notifier-0.1.0/tests/test_replay_m31.py +70 -0
  122. ekos_notifier-0.1.0/tests/test_rules.py +166 -0
  123. ekos_notifier-0.1.0/tests/test_service.py +72 -0
  124. ekos_notifier-0.1.0/tests/test_session.py +275 -0
  125. ekos_notifier-0.1.0/tests/test_simulate.py +103 -0
  126. ekos_notifier-0.1.0/tests/test_sky.py +189 -0
  127. ekos_notifier-0.1.0/tests/test_stats.py +71 -0
  128. ekos_notifier-0.1.0/tests/test_store.py +160 -0
  129. ekos_notifier-0.1.0/tools/check_install.sh +53 -0
  130. ekos_notifier-0.1.0/tools/indi_power_simulator/power_simulator.cpp +117 -0
  131. ekos_notifier-0.1.0/tools/record_night.py +195 -0
  132. ekos_notifier-0.1.0/tools/scrub_replay.py +197 -0
  133. ekos_notifier-0.1.0/tools/sim_night.py +280 -0
@@ -0,0 +1,27 @@
1
+ name: Bug report
2
+ description: Something didn't work as expected
3
+ labels: [bug]
4
+ body:
5
+ - type: textarea
6
+ id: what
7
+ attributes:
8
+ label: What happened, and what did you expect?
9
+ validations:
10
+ required: true
11
+ - type: textarea
12
+ id: doctor
13
+ attributes:
14
+ label: Output of `ekos-notifier doctor`
15
+ render: text
16
+ - type: input
17
+ id: platform
18
+ attributes:
19
+ label: Platform
20
+ placeholder: "StellarMate OS 2.x (Arch/Flatpak), Astroberry, Ubuntu 24.04 + KStars 3.8.3…"
21
+ validations:
22
+ required: true
23
+ - type: input
24
+ id: guider
25
+ attributes:
26
+ label: Guider
27
+ placeholder: "PHD2 2.6.x or Ekos internal"
@@ -0,0 +1,21 @@
1
+ name: Device support request
2
+ description: Ask for a power box, weather station or sensor preset
3
+ labels: [device-support]
4
+ body:
5
+ - type: input
6
+ id: device
7
+ attributes:
8
+ label: Device make and model
9
+ placeholder: "Pegasus Pocket Powerbox Advance Gen2"
10
+ validations:
11
+ required: true
12
+ - type: input
13
+ id: driver
14
+ attributes:
15
+ label: INDI driver name
16
+ - type: textarea
17
+ id: dump
18
+ attributes:
19
+ label: Output of `ekos-notifier indi-dump`
20
+ description: Attach the file it writes, or paste it here.
21
+ render: text
@@ -0,0 +1,42 @@
1
+ name: CI
2
+
3
+ on:
4
+ push:
5
+ branches: [main]
6
+ pull_request:
7
+
8
+ jobs:
9
+ test:
10
+ runs-on: ubuntu-latest
11
+ strategy:
12
+ matrix:
13
+ python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
14
+ steps:
15
+ - uses: actions/checkout@v4
16
+ - uses: actions/setup-python@v5
17
+ with:
18
+ python-version: ${{ matrix.python-version }}
19
+ - run: pip install -e ".[dev]"
20
+ - run: ruff check .
21
+ - run: ruff format --check .
22
+ - run: pytest
23
+
24
+ docs:
25
+ runs-on: ubuntu-latest
26
+ steps:
27
+ - uses: actions/checkout@v4
28
+ - uses: actions/setup-python@v5
29
+ with:
30
+ python-version: "3.13"
31
+ - run: pip install -e ".[dev]"
32
+ - run: mkdocs build --strict
33
+
34
+ install:
35
+ # install.sh end to end in a throwaway home (Ubuntu's sh is dash: a strict POSIX check).
36
+ runs-on: ubuntu-latest
37
+ steps:
38
+ - uses: actions/checkout@v4
39
+ - uses: actions/setup-python@v5
40
+ with:
41
+ python-version: "3.12"
42
+ - run: PYTHON="$(command -v python)" sh tools/check_install.sh
@@ -0,0 +1,74 @@
1
+ name: Release
2
+
3
+ # Pushing a tag like v0.1.0 builds the package, publishes it to PyPI and creates the GitHub
4
+ # release with that version's CHANGELOG section. PyPI trusts this workflow directly (trusted
5
+ # publishing): no API token is stored anywhere.
6
+
7
+ on:
8
+ push:
9
+ tags: ["v*"]
10
+
11
+ jobs:
12
+ build:
13
+ runs-on: ubuntu-latest
14
+ steps:
15
+ - uses: actions/checkout@v4
16
+ - uses: actions/setup-python@v5
17
+ with:
18
+ python-version: "3.13"
19
+ - name: The tag matches the package version
20
+ run: |
21
+ version=$(sed -n 's/^__version__ = "\(.*\)"$/\1/p' src/ekos_notifier/__init__.py)
22
+ echo "package $version, tag $GITHUB_REF_NAME"
23
+ test "v$version" = "$GITHUB_REF_NAME"
24
+ - name: The CHANGELOG has this version
25
+ run: grep -q "^## ${GITHUB_REF_NAME#v} " CHANGELOG.md
26
+ - run: pip install build twine
27
+ - run: python -m build
28
+ - run: twine check --strict dist/*
29
+ - name: The wheel installs and runs
30
+ run: |
31
+ python -m venv /tmp/check
32
+ /tmp/check/bin/pip install dist/*.whl
33
+ /tmp/check/bin/ekos-notifier --version
34
+ HOME=/tmp/home /tmp/check/bin/ekos-notifier config init
35
+ - uses: actions/upload-artifact@v4
36
+ with:
37
+ name: dist
38
+ path: dist/
39
+
40
+ pypi:
41
+ needs: build
42
+ runs-on: ubuntu-latest
43
+ environment:
44
+ name: pypi
45
+ url: https://pypi.org/project/ekos-notifier/
46
+ permissions:
47
+ id-token: write # trusted publishing
48
+ steps:
49
+ - uses: actions/download-artifact@v4
50
+ with:
51
+ name: dist
52
+ path: dist/
53
+ - uses: pypa/gh-action-pypi-publish@release/v1
54
+
55
+ github-release:
56
+ needs: pypi
57
+ runs-on: ubuntu-latest
58
+ permissions:
59
+ contents: write
60
+ steps:
61
+ - uses: actions/checkout@v4
62
+ - uses: actions/download-artifact@v4
63
+ with:
64
+ name: dist
65
+ path: dist/
66
+ - name: Notes from the CHANGELOG
67
+ run: |
68
+ awk -v v="${GITHUB_REF_NAME#v}" '
69
+ /^## / { if (p) exit; if ($2 == v) { p = 1; next } }
70
+ p' CHANGELOG.md > notes.md
71
+ test -s notes.md
72
+ - env:
73
+ GH_TOKEN: ${{ github.token }}
74
+ run: gh release create "$GITHUB_REF_NAME" dist/* --title "$GITHUB_REF_NAME" --notes-file notes.md
@@ -0,0 +1,235 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[codz]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ /lib/
18
+ /lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py.cover
50
+ *.lcov
51
+ .hypothesis/
52
+ .pytest_cache/
53
+ cover/
54
+
55
+ # Translations
56
+ *.mo
57
+ *.pot
58
+
59
+ # Django stuff:
60
+ *.log
61
+ local_settings.py
62
+ db.sqlite3
63
+ db.sqlite3-journal
64
+
65
+ # Flask stuff:
66
+ instance/
67
+ .webassets-cache
68
+
69
+ # Scrapy stuff:
70
+ .scrapy
71
+
72
+ # Sphinx documentation
73
+ docs/_build/
74
+
75
+ # PyBuilder
76
+ .pybuilder/
77
+ target/
78
+
79
+ # Jupyter Notebook
80
+ .ipynb_checkpoints
81
+
82
+ # IPython
83
+ profile_default/
84
+ ipython_config.py
85
+
86
+ # pyenv
87
+ # For a library or package, you might want to ignore these files since the code is
88
+ # intended to run in multiple environments; otherwise, check them in:
89
+ # .python-version
90
+
91
+ # pipenv
92
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
93
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
94
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
95
+ # install all needed dependencies.
96
+ # Pipfile.lock
97
+
98
+ # uv
99
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
100
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
101
+ # commonly ignored for libraries.
102
+ # uv.lock
103
+
104
+ # poetry
105
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
106
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
107
+ # commonly ignored for libraries.
108
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
109
+ # poetry.lock
110
+ # poetry.toml
111
+
112
+ # pdm
113
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
114
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
115
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
116
+ # pdm.lock
117
+ # pdm.toml
118
+ .pdm-python
119
+ .pdm-build/
120
+
121
+ # pixi
122
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
123
+ # pixi.lock
124
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
125
+ # in the .venv directory. It is recommended not to include this directory in version control.
126
+ .pixi/*
127
+ !.pixi/config.toml
128
+
129
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
130
+ __pypackages__/
131
+
132
+ # Celery stuff
133
+ celerybeat-schedule*
134
+ celerybeat.pid
135
+
136
+ # Redis
137
+ *.rdb
138
+ *.aof
139
+ *.pid
140
+
141
+ # RabbitMQ
142
+ mnesia/
143
+ rabbitmq/
144
+ rabbitmq-data/
145
+
146
+ # ActiveMQ
147
+ activemq-data/
148
+
149
+ # SageMath parsed files
150
+ *.sage.py
151
+
152
+ # Environments
153
+ .env
154
+ .envrc
155
+ .venv
156
+ env/
157
+ venv/
158
+ ENV/
159
+ env.bak/
160
+ venv.bak/
161
+
162
+ # Spyder project settings
163
+ .spyderproject
164
+ .spyproject
165
+
166
+ # Rope project settings
167
+ .ropeproject
168
+
169
+ # mkdocs/Zensical documentation
170
+ /site
171
+
172
+ # mypy
173
+ .mypy_cache/
174
+ .dmypy.json
175
+ dmypy.json
176
+
177
+ # Pyre type checker
178
+ .pyre/
179
+
180
+ # pytype static type analyzer
181
+ .pytype/
182
+
183
+ # Cython debug symbols
184
+ cython_debug/
185
+
186
+ # PyCharm
187
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
188
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
189
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
190
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
191
+ # .idea/
192
+
193
+ # Abstra
194
+ # Abstra is an AI-powered process automation framework.
195
+ # Ignore directories containing user credentials, local state, and settings.
196
+ # Learn more at https://abstra.io/docs
197
+ .abstra/
198
+
199
+ # Visual Studio Code
200
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore that
201
+ # can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
202
+ # and can be added to the global gitignore or merged into this file. However, if you prefer, you
203
+ # could uncomment the following to ignore the entire vscode folder
204
+ # .vscode/
205
+ # Temporary file for partial code execution
206
+ tempCodeRunnerFile.py
207
+
208
+ # Ruff stuff:
209
+ .ruff_cache/
210
+
211
+ # PyPI configuration file
212
+ .pypirc
213
+
214
+ # Marimo
215
+ marimo/_static/
216
+ marimo/_lsp/
217
+ __marimo__/
218
+
219
+ # Streamlit
220
+ .streamlit/secrets.toml
221
+
222
+ # --- Ekos Notifier ---
223
+ # Local runtime data
224
+ *.db
225
+ *.db-wal
226
+ *.db-shm
227
+ /sessions/
228
+ # Real configs hold notifier keys; commit config.example.yaml instead
229
+ config.yaml
230
+ # Imaging data never belongs in git
231
+ *.fits
232
+ *.fit
233
+ *.xisf
234
+ # Recorded nights, logs and dumps used as test fixtures must stay tracked
235
+ !tests/fixtures/**
@@ -0,0 +1,234 @@
1
+ # Changelog
2
+
3
+ All notable changes are recorded here. The format follows Keep a Changelog, and versions follow
4
+ Semantic Versioning.
5
+
6
+ ## Unreleased
7
+
8
+ ## 0.1.0 — 2026-11-19
9
+
10
+ The first release: the 0.1 "Core" milestone. Ekos Notifier follows Ekos (D-Bus), PHD2 and
11
+ INDI, records each night as a session in a local SQLite database, and sends alerts, an hourly
12
+ digest and a session summary to any Apprise notifier. Installed with `install.sh` (a venv in
13
+ your home folder, no root). Pre-alpha: not yet field-tested on real rigs, and settings may
14
+ change before 1.0. Not yet built: the setup wizard, `doctor`, the web dashboard, sync, the
15
+ heartbeat, and the Terse and Olde English styles.
16
+
17
+ - **Hardening, from a pre-release review:**
18
+ - The notifier survives a failed pass (the database busy, a notifier library raising): it
19
+ logs the traceback, backs off and carries on, instead of stopping the service.
20
+ - Calls to KStars over D-Bus give up after 10 s, so a hung KStars can't pile up tasks.
21
+ - An unexpected error in the Ekos, PHD2 or INDI source is logged with its traceback (a
22
+ connection coming and going is still one line).
23
+ - A broken config at startup no longer stops the service: it records the night without
24
+ alerts, and the fixed file is picked up by itself.
25
+ - A database from a newer version stops the service with exit code 78, which the unit no
26
+ longer restarts on (`RestartPreventExitStatus=78`), instead of retrying every 10 s.
27
+
28
+ - **Fixed:** `ekos-notifier install-service` run while the service is up (re-installing, or
29
+ an installer upgrade) said another copy was "probably in a terminal" and didn't apply the new
30
+ unit. It now recognises the service and restarts it on the new unit and version; the warning
31
+ is left for a copy that really is running elsewhere.
32
+
33
+ - **`install.sh`**: installs into a venv in your home folder with no root and no extra tools
34
+ (`curl -fsSL …/install.sh | sh`), links `~/.local/bin/ekos-notifier`,
35
+ writes a commented config and offers the systemd user service. Re-run to upgrade (restarting
36
+ the service; rebuilding the venv after a Python upgrade); `--uninstall` keeps config and
37
+ sessions. **`ekos-notifier config init`** writes the commented example config (mode 600),
38
+ now shipped inside the package. CI runs the installer end to end.
39
+ - **Config reload**: the running service applies an edited config by itself within seconds
40
+ (or at once with `systemctl --user reload ekos-notifier`): new notifier URLs, message
41
+ levels and thresholds take effect without losing the night's state, and the INDI connection
42
+ restarts if its settings changed. A config with a mistake is logged and ignored.
43
+ - **README**: a step-by-step install and setup guide (notifier URLs, editing the config,
44
+ messages, thresholds, devices, troubleshooting). The example config's commented examples can
45
+ now be used by deleting the `#` (under `messages: {}` that made invalid YAML), and settings
46
+ not used yet are marked so.
47
+
48
+ - **Clouds** (High): PHD2's guide star fading by half for 2 minutes, or two frames in a row
49
+ losing half their stars, with the numbers; **Clouds passed** when the stars are back. A star
50
+ lost at full brightness isn't clouds (that's Guiding lost). `alerts: clouds_drop_percent`
51
+ (default 50, 0 = off). Thresholds to be tuned on a real cloudy night.
52
+
53
+ - **Pre-flight checks** in "Starting session": battery, free disk space, dew margin and
54
+ humidity, and the camera against its setpoint; failed checks are listed first as warnings.
55
+ The **session summary** adds median HFR and guide RMS, temperature, humidity and camera
56
+ temperature ranges, the lowest battery voltage and the problems raised. The **hourly digest**
57
+ no longer says "All's well" when no light frame was saved in the hour ("No light frames since
58
+ 21:40").
59
+
60
+ - **Flats reminder** (Normal, with the session summary): filters with lights but no flats tonight,
61
+ once per filter per night. **Darks reminder** (off by default): "cover the telescope" when a
62
+ dark job starts; the Ekos adapter now reads the active Capture job's frame type (`capture.job`).
63
+ `messages:` supports alerts that are off unless turned on.
64
+
65
+ - Choose which messages you get: a `messages:` section in the config sets any alert to `off`,
66
+ `digest`, `quiet`, `normal`, `high` or `emergency`; all-clears follow their problem when it's
67
+ off or held for the digest. `ekos-notifier config alerts` lists every alert with its default
68
+ and your setting; `config check` flags unknown names (with a suggestion) and lowered
69
+ Emergencies. A registry of every alert (`ekos_notifier.messages`), checked against the code by
70
+ a test.
71
+
72
+ - **Plate solve failed** (High): an Ekos Align run fails and no solve succeeds within 3 min,
73
+ saying whether it followed the meridian flip or a new Scheduler target, with Ekos's reason;
74
+ "Plate solve succeeded" after.
75
+
76
+ - `ekos-notifier simulate`: replay a night and print every alert it would send, with your config:
77
+ the sample night (now shipped in the package), a recording, or one of your sessions from the
78
+ database (`--session last`, `--list`; read-only). `--brief` for titles, `--send` to send them
79
+ marked [Simulated] (an Emergency as High). The mount-limit Emergency is planned for after 1.0.
80
+
81
+ - **Meridian flip failed** and **Meridian flip overdue** (Emergency), with "Meridian flip done"
82
+ after. Ekos's Mount module logs its flips only in its `logText` property (no `newLog` signal),
83
+ which the Ekos adapter now polls every 10 s, so Mount's log lines are recorded too. Overdue: the
84
+ mount still on its pre-flip pier side 15 min plus one exposure after the flip time.
85
+ - **Disk low** (High): under `alerts.disk_low_gb` free where Ekos saves frames, with frames and
86
+ time left at tonight's pace; "Disk space OK" after. `alerts.disk_low_gb` is now read.
87
+
88
+ - **Dew risk** (High): dew margin under `alerts.dew_margin_c` or humidity over 90 % for 5 min,
89
+ naming dew heaters that are off; "Dew risk passed" in the digest. **Cooler can't hold** and
90
+ **Cooler can't reach setpoint** (High), with "Cooler at setpoint" after: the setpoint comes from
91
+ Ekos Capture's log, or from the camera driver reporting it reached its target (new
92
+ `camera.cooler` events). `alerts.dew_margin_c` and `alerts.cooler_tolerance_c` are now read.
93
+ - Install plan: an `install.sh` (a venv in your home folder, no root, no pipx) ships with 1.0,
94
+ since StellarMate's images have neither pipx nor pacman repositories. Docs updated.
95
+ - **Power boxes, whatever the brand:** a preset for libindi 2.x's standard power interface
96
+ (Pegasus PPB/PPBA/SPB/UPB/UPB3, SVBONY, Terrans, Celestron Dew Power, Gemini PBH, smPro, …):
97
+ input voltage, current and power as metrics, and each output's on/off, current and label
98
+ (`power.output` events). **Battery critical** (Emergency, also outside a session), **Battery
99
+ low** (High, once) and **Battery OK**, with `power.battery` presets (`agm_12v`, `lifepo4_12v`,
100
+ `mains`, `custom`) and `low_volts`/`critical_volts`. **Power output off** and **No current on**
101
+ an output (High) during a session, not when Ekos shuts down; **Power output back**. The digest
102
+ shows "Power 12.4 V (low 12.1 V), 4.2 A". `indi-dump` no longer lists a box's outputs as
103
+ candidates. Verified against a test driver built on libindi 2.2.5's `INDI::PowerInterface`.
104
+
105
+ - Fixes from the live sky test: "Starting session" now comes before the alerts it leads to;
106
+ "Twilight coming" is sent once per night, not again with every short session; a meridian flip
107
+ (the mount swinging through the pole and back) no longer counts as a new target, so "Target
108
+ low" isn't repeated. Confirmed live: Ekos flipped at 07:07:53, predicted 07:07.
109
+ - **Twilight coming** and **Target low** (Normal, immediate) and **Meridian flip soon** (Quiet,
110
+ for the digest), from a small pure-Python ephemeris (`ekos_notifier.ephemeris`: sidereal time,
111
+ Sun, altitudes, crossings). Site from KStars's `location()` (or the mount's INDI
112
+ `GEOGRAPHIC_COORD`), target from the mount's INDI coordinates, limits from Ekos (`[Mount]` flip
113
+ and altitude settings, the Scheduler's altitude constraint). The digest shows time to the flip,
114
+ to the target's altitude limit and to dawn. Config `alerts.twilight_warning_minutes`,
115
+ `alerts.target_low_warning_minutes` are now read.
116
+ - No session summary when you stop Ekos yourself (Ekos logs "Disconnecting INDI devices…"
117
+ first): the session closes quietly as `ekos_stopped`. A crash (KStars vanishing, an error, Ekos
118
+ idle with no shutdown logged) closes as `ekos_lost` with a summary. The "mount unparked"
119
+ Emergency is sent either way. After a service restart, a session keeps the time and kind of
120
+ the Ekos stop before it and its summary counts the session's frames (it said "No light
121
+ frames", and the restart time as the end).
122
+ - `ekos-notifier install-service`: a systemd user service (`ExecStart=<this Python> -m
123
+ ekos_notifier run`, restart on failure, wanted by `default.target`), enabled and started;
124
+ `--no-start`, `--uninstall`, `--config`. One Ekos Notifier per database: a second copy refuses
125
+ to start instead of sending every alert twice. `python -m ekos_notifier` runs the CLI.
126
+ - **INDI adapter** (`ekos_notifier.indi`): a read-only client of the INDI server the Ekos
127
+ profile uses. Presets (YAML, by interface or driver) map device properties to canonical
128
+ metrics: weather stations, camera and focuser temperatures built in; anything else via
129
+ `indi.metrics` in the config. Dew point derived when a device has temperature and humidity.
130
+ `metric`, `indi.device` and `indi.capabilities` events; samples keep their source device
131
+ (schema 4) and frames get the imaging camera's temperature. The digest shows camera
132
+ temperature, ambient, RH and dew margin, and the Capture target for manual sessions.
133
+ `ekos-notifier indi-dump` writes every device's properties (site location removed) and lists
134
+ candidate readings.
135
+ - INDI fixes from the live test: a reading stays current until INDI says the device or property
136
+ is gone (INDI sends values only when they change, so a settled cooler goes quiet and frames had
137
+ lost their camera temperature); `indi-dump` also removes user names from home paths and no
138
+ longer lists simulator settings or "…_CURRENT_ENTRY" counters as candidates.
139
+ - **Hourly digest** (`ekos_notifier.digest`): on the hour during a session, "HH:MM — All's
140
+ well" (Quiet, sent silently) or "HH:MM — Attention: …" (Normal) when a problem was raised and
141
+ not cleared, or is still open. Target, filter, job progress, lights and integration this
142
+ interval and tonight, calibration, median guide RMS, failed dithers, median HFR, and every
143
+ alert and milestone since the last digest. Config `digest:` (`enabled`, `interval_minutes`,
144
+ `align_to_clock`) is now read (the pre-rename `crier:` section still is). Immediate alerts are
145
+ sent at their own priority, so Quiet ones go out silently instead of being held. A capture
146
+ abort, Scheduler abort or autofocus failure stays "Still open" until things work again, and
147
+ open problems and the session's start survive a service restart.
148
+ - More High alerts: **Guiding poor** (follows Ekos's own guide-deviation limit: when a job
149
+ enforces it, the time Ekos holds exposures; otherwise Ekos's guide RMS over that limit; config
150
+ `alerts.guiding_poor_minutes`, default 10), **Capture aborted** (with Ekos's reason; aborts with
151
+ no cause are taken as the user's Stop), **Scheduler aborted**, **Capture stalled** (no progress
152
+ for 2 × (exposure + download), at least 2 min) with "Capture running again", and **Autofocus
153
+ failed** (two runs in a row, Ekos's retry loop counted once). Shaped by live tests: Ekos's
154
+ limit makes it suspend and resume over and over, so the clock runs until a frame finishes; a
155
+ failed autofocus ends `aborted` with the failure only in the log; Capture reported `aborted`
156
+ while idle isn't an abort; PHD2 warnings caused by stopping Ekos are dropped.
157
+ - **Guiding lost** alert (High, `ekos_notifier.guiding`): guiding stopped and not back within
158
+ `alerts.guiding_recovery_minutes` (default 5) of time when guiding was expected, then
159
+ **Guiding recovered**. Intent-aware: slews, meridian flips, plate solving, autofocus, flats with
160
+ tracking off, calibration frames and the end of the run pause the clock; a guider stuck
161
+ recalibrating doesn't count as recovered. Uses Ekos's Guide state (internal guider or PHD2)
162
+ and PHD2's own lost-star reports; replays of the M 31 and IC 410 nights send no false alarm.
163
+ - **PHD2 warning** alert (High): PHD2's warnings and errors during a session, once per message
164
+ per session, with the current guide RMS; its dark-library advice, info messages and the
165
+ warnings caused by the Scheduler's shutdown aren't sent. Rules now also pick up an active
166
+ session after a service restart (before, guiding alerts went silent until the next session),
167
+ without resending PHD2 warnings already sent in it.
168
+ - **Renamed to Ekos Notifier** (was Town Crier): PyPI `ekos-notifier`, command `ekos-notifier`,
169
+ package `ekos_notifier`, repository `anandvn/ekos-notifier`. The hourly "town crier" digest is
170
+ now the hourly digest (config `digest:`, was `crier:`); the Olde English style stays. On first
171
+ run, `~/.config/town-crier` and `~/.local/share/town-crier` (database and WAL files) move to
172
+ the new names, unless the new folders exist or an old process still has the database open.
173
+ Recordings in the old `town-crier-replay/0` format still load.
174
+ - Ekos adapter (`ekos_notifier.ekos`): finds the session bus KStars is on, listens to Ekos signals
175
+ by the `org.kde.kstars` name (modules that appear later are covered), reports KStars appearing
176
+ and vanishing, reads current states on connect, and reconnects with backoff. Signals become
177
+ `Event`s (`capture.frame`, `mount.park`, `scheduler.state`, …); state codes are named, with
178
+ those checked against a recording marked. `ekos_notifier.replay` runs recordings through the same
179
+ decoder. New dependency: `dbus-fast`.
180
+ - Tests driven by the M 31 replay fixture.
181
+ - PHD2 adapter (`ekos_notifier.phd2`): reads PHD2's event server on localhost:4400 (read-only) and
182
+ records guide steps (pixels, pulses, SNR, mass, HFD), guider state, lost stars, settle
183
+ results, dithers, calibration and PHD2's alerts. The connect burst is marked as a snapshot;
184
+ reconnects with backoff and waits quietly while PHD2 isn't running. Reads which guider Ekos
185
+ uses from the running KStars (Flatpak or native): the selected profile's guider in
186
+ `userdb.sqlite` and the Guide module's setting in `kstarsrc`. Connects to the PHD2 host and
187
+ port Ekos uses, and doesn't contact PHD2 at all when both say internal or lin_guider. `ekos-notifier run` starts it
188
+ alongside the Ekos adapter, and `replay.events()` replays both from a recording.
189
+ - Event store (`ekos_notifier.store`): SQLite in WAL mode with versioned migrations. Every event is
190
+ appended to `events`; `frames` (with the guide RMS at capture time) and `samples` are filled
191
+ in the same transaction. `EventWriter` batches events from asyncio code onto the store's own
192
+ thread and retries failed writes rather than dropping them.
193
+ - Session manager (`ekos_notifier.session`): Standby → Setup → Active → Closed from Ekos events;
194
+ tags every event with its session, attaches setup to the session it leads into and late
195
+ calibration frames to the last imaging session. Closes when the Scheduler stops (finished or
196
+ aborted, parked or not) or a manual sequence completes, on GUI End, on Ekos gone for 10 minutes (a crash and restart doesn't split the night), or the night ending.
197
+ Resumes an open session after a service restart. New `sessions` table (schema 2).
198
+ - `ekos-notifier run`: the service in the foreground. Ekos adapter → session manager → store, with a
199
+ clock tick for time-based session rules; SIGINT/SIGTERM stop it cleanly and everything queued
200
+ is written. `--db`, `-v`.
201
+ - Fixed: stopping the writer mid-batch or before its database was open dropped queued events.
202
+ - Notifications. Rules (`ekos_notifier.rules`) turn events into alerts stored as events: "Starting
203
+ session" and the session summary (Normal, sent at once), and the "Ekos stopped with the mount
204
+ unparked" Emergency (2 minutes after Ekos stops, with an all-clear when the mount parks). The
205
+ notifier (`ekos_notifier.notify`) sends them through Apprise from an outbox. An alert that can't
206
+ be delivered is retried for 10 minutes (`notify_expire_minutes`) and then dropped, not sent
207
+ late; it stays in the local record. Pushover Emergencies repeat every 60 s until acknowledged (up to an hour), ntfy
208
+ gets matching priorities, other services get the priority in the title. Schema 3: `outbox`,
209
+ `consumers`. New dependencies: `apprise`, `PyYAML`.
210
+ - Config file (`~/.config/ekos-notifier/config.yaml`, `notify:` so far); `ekos-notifier run --config`.
211
+ - `ekos-notifier config check` validates the config and every notifier URL (keys hidden).
212
+ - `ekos-notifier test-notify [--emergency]` sends a test message to every notifier.
213
+ - Replay ticks the clock in recorded time (`pipeline.simulate`), so timers fire when they would
214
+ have on the night. The service ticks every 10 s.
215
+ - Fixed: the writer waited its gathering window before every batch even with a backlog queued.
216
+ - Project skeleton: design spec, briefing for contributors, CLI stub, CI, docs site scaffold.
217
+ - Planned `ekos-notifier config check` subcommand added to the CLI stub.
218
+ - Stub commands exit with code 3 (not 2, which is argparse's usage-error code).
219
+ - Design: the GUI uses Starlette (not FastAPI) and the Ekos adapter uses `dbus-fast` (not the
220
+ unmaintained `dbus-next`).
221
+ - Design: platform matrix (StellarMate, Astroberry OS, Raspberry Pi OS, Ubuntu, AstroArch); the
222
+ service runs where KStars runs, finds the session bus, and reads INDI host/port from the Ekos
223
+ profile. Flatpak findings from the dev VM recorded in `docs/open-questions.md`.
224
+ - Test fixtures: Ekos/INDI D-Bus introspection from KStars 3.8.5 (Flatpak) with Ekos running.
225
+ - Developer tools: `tools/record_night.py` (records D-Bus, PHD2 and INDI streams as a replay
226
+ file), `tools/sim_night.py` (drives a simulated night through Ekos), `tools/scrub_replay.py`
227
+ (removes site coordinates and hostnames before a recording is committed).
228
+ - `tools/scrub_replay.py`: joins several recordings, trims to a time window (`--since`/`--until`),
229
+ drops non-KStars D-Bus traffic and INDI debug messages (`--keep-noise` keeps them), and scrubs
230
+ site coordinates written as degrees and minutes. `--since`/`--until` take ISO 8601 with an
231
+ offset. The `GEOGRAPHIC_COORD` rewrite now works (it
232
+ never matched JSON-escaped quotes, so elevation was left unscrubbed).
233
+ - Design: new Emergency alert "Ekos stopped with the mount unparked", because the Ekos Scheduler
234
+ stops Ekos and disconnects INDI when a job finishes or aborts, even with the mount tracking.