Skip to content

Commit

Permalink
Update README and changelog for 0.4.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
newAM committed Oct 20, 2020
1 parent a5a76a0 commit 337c298
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 14 deletions.
36 changes: 25 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,13 @@ Then install all the packages using poetry install:
poetry install
To install this as a command available from the system build the package then
install it with pip:
To install this package locally build it then install with pip:


.. code-block:: bash
poetry build
python3.8 -m pip install dist/idasen-0.2.0-py3-none-any.whl
python3.8 -m pip install dist/idasen-0.4.0-py3-none-any.whl
Configuration
*************
Expand All @@ -62,15 +61,24 @@ You can use this command to initialize a new configuartion file:
idasen init
.. code-block:: yaml
mac_address: AA:AA:AA:AA:AA:AA
positions:
sit: 0.75
stand: 1.1
Configuartion options:

* ``mac_address`` - The MAC address of the desk. This is required.
* ``stand_height`` - The standing height from the floor of the desk in meters.
* ``sit_height`` - The standing height from the floor of the desk in meters.
* ``positions`` - A dictionary of positions with values of desk height from the
floor in meters, ``sit`` and ``stand`` are provided as examples.

The program will try to find the device address, but if it fails, it has to be done manually.
Device MAC addresses can be found using ``blueoothctl`` and bluetooth adapter
names can be found with ``hcitool dev`` on linux.
The program will try to find the device address,
but if it fails, it has to be done manually.

The device MAC addresses can be found using ``blueoothctl`` and bluetooth
adapter names can be found with ``hcitool dev`` on linux.

Usage
*****
Expand All @@ -84,17 +92,23 @@ To print the current desk height:
idasen height
To monitor for changes to height :
To monitor for changes to height:

.. code-block:: bash
idasen monitor
Assuming the config file is populated to move the desk to standing position:
To save the current height as the sitting position:

.. code-block:: bash
idasen save sit
To delete the saved sitting position:

.. code-block:: bash
idasen stand
idasen delete sit
Assuming the config file is populated to move the desk to sitting position:

Expand Down
18 changes: 16 additions & 2 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
Change Log
##########

Unreleased
**********
`0.4.0`_ 2020-10-20
*******************

Added
=====
- Added ``save`` and ``delete`` sub-commands to the CLI to save and delete
desk positions.

Changed
=======
- Changed the configuration file format, see the README for details.

Fixed
=====
- Fixed a bug with the ``init`` sub-command raising an exception.

`0.3.0`_ 2020-10-10
*******************
Expand Down Expand Up @@ -34,6 +47,7 @@ Changed
*******************
- Initial release

.. _0.4.0: https://github.com/newAM/idasen/releases/tag/v0.4.0
.. _0.3.0: https://github.com/newAM/idasen/releases/tag/v0.3.0
.. _0.2.1: https://github.com/newAM/idasen/releases/tag/v0.2.1
.. _0.2.0: https://github.com/newAM/idasen/releases/tag/v0.2.0
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ target-version = ["py38"]
name = "idasen"
description = "ikea IDÅSEN desk API and CLI."
authors = ["Alex M. <[email protected]>"]
version = "0.3.0"
version = "0.4.0"
license = "MIT"
readme = "README.rst"
repository = "https://github.com/newAM/idasen"
Expand Down

0 comments on commit 337c298

Please sign in to comment.