Skip to content

Commit d6899a9

Browse files
committed
Documentation changes for 1.0.1
1 parent c1b881e commit d6899a9

5 files changed

Lines changed: 21 additions & 9 deletions

File tree

CHANGES.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
Version 1.0.1 Update (2025-02-05)
2+
=================================
3+
* This responds to `GitHub Issue #16
4+
<https://github.com/ASCOMInitiative/AlpycaDevice/issues/16>`_ to add the
5+
missing ``on_put()`` (property write) to the ``Connected`` property of all
6+
templates.
7+
* The ``Id`` paraameter to some ``Switch`` members has correct capitalization.
8+
19
Version 1.0.0 Production (2024-09-15, for Platform 7)
210
=======================================================
311
* Add symbolic enums to templates since they are not part of the JSON OpenAPI

RBD-Notes.txt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,10 @@ along with rst-check, leaving rstcheck as the linter. Good enough.
240240
-----------
241241
* See GitHub Issue #15 https://github.com/ASCOMInitiative/AlpycaDevice/issues/15 ... the OmniSimulators 0.4.1 has 'ID' in the Switch method parameters. ConformU 4.1.0 tests OmniSim 0.4.1 successfully. So which is it???
242242

243-
07-Jan-2024
243+
07-Jan-2025
244244
-----------
245245
* It's 'Id' as in the Master Interfaces. Peter fixed the OmniSim and gave me a new JSON input for the templates AlpacaDeviceAPI_v2_plat7-0.4.1.json
246+
247+
05-Feb-2025
248+
-----------
249+
* 1.0.1 Regenerated templates for the Id thing and for Fix #16 for property Connected on_put() and a typo. 1.0.1.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# AlpycaDevice - Python Alpaca Device Driver SDK
22

3-
## Version 1.0.0, September 13, 2024 (ASCOM Platform 7)
3+
## Version 1.0.1, February 5, 2025 (ASCOM Platform 7)
44

55
<img align="right" width="210" height="166" hspace="20" vspace="20" src="https://ascom-standards.org/alpyca/readme-assets/AlpacaLogo210.png">
66

77
This project is a lightweight Python framework for a device
88
driver that supports the Alpaca protocol and ASCOM Standards as of Platform 7. It implements a basic Rotator device with a simple simulation for Conform tests. **Templates for all ASCOM device types are provided**.
99
The "boiler plate" logic remains the same for any device.
1010

11-
## [AlpycaDevice SDK 1.0.0 Documentation](https://ascom-standards.org/alpycadevice/)
11+
## [AlpycaDevice SDK 1.0.1 Documentation](https://ascom-standards.org/alpycadevice/)
1212

1313
[![AlpycaDevice Video](https://raw.githubusercontent.com/BobDenny/AlpycaDevice/master/docs/source/vthumb.png)](https://www.youtube.com/watch?v=soGb0j4iOt4 "AlpycaDevice Video")
1414

docs/source/conf.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ class Desc_Sig_Space(DocutilsInlineNode):
3030
# -- Project information -----------------------------------------------------
3131

3232
project = 'AlpycaDevice SDK'
33-
copyright = '2022-2024, ASCOM Initiative, MIT License'
33+
copyright = '2022-2025, ASCOM Initiative, MIT License'
3434
author = 'Bob Denny'
3535

3636
# The full version, including alpha/beta/rc tags
37-
version = '1.0.0'
38-
release = '1.0.0'
37+
version = '1.0.1'
38+
release = '1.0.1'
3939

4040
# -- General configuration ---------------------------------------------------
4141
#
@@ -125,7 +125,7 @@ class Desc_Sig_Space(DocutilsInlineNode):
125125
rinoh_documents = [dict(doc='index', # top-level file (index.rst)
126126
target='alpyca', # output file (alpyca.pdf)
127127
title='Alpyca Device',
128-
subtitle='Release 1.0.0',
128+
subtitle='Release 1.0.1',
129129
author='Robert B. Denny <rdenny@dc3.com>',
130130
logo='alpaca1000.png',
131131
template='alpyca.rtt')]

docs/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ conforming Alpaca device with a minimum of "just in time learning".
2525
**Start Here:** :doc:`/quickstart` then look through :doc:`/introduction`.
2626

2727
.. Note::
28-
This is the 1.0.0 (September, 2024) production version. This is the first
29-
release that contains the additions to the interfaces for Platform 7.
28+
This is the 1.0.1 (February 5, 2025) updated production version. This
29+
contains the additions to the interfaces for Platform 7.
3030
See |plat7changes|. For Release Notes on this SDK see the
3131
|changes| on the |github|.
3232

0 commit comments

Comments
 (0)