Skip to content

Commit

Permalink
Bumping version to v0.7.0 for release
Browse files Browse the repository at this point in the history
  • Loading branch information
twystd committed Jun 11, 2021
1 parent 3560f22 commit a4f8af4
Show file tree
Hide file tree
Showing 5 changed files with 68 additions and 68 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
VERSION = v0.7.x
VERSION = v0.7.0
LDFLAGS = -ldflags "-X uhppote.VERSION=$(VERSION)"
DIST ?= development
CLI = ./bin/uhppote-cli
Expand Down
115 changes: 58 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ savings changes.

| *Version* | *Description* |
| --------- | -------------------------------------------------------------------------------------------------------- |
| v0.7.0 | Added commands to get-, set- and clear time profiles |
| v0.6.12 | Added validation for `bind`, `broadcast` and `listen` ports |
| v0.6.10 | Maintenance release for version compatibility with `uhppoted-app-wild-apricot` |
| v0.6.8 | Maintenance release for version compatibility with `uhppote-core` `v0.6.8` |
Expand Down Expand Up @@ -91,35 +92,35 @@ General_ commands:

Device commands:

- [`get-devices`](https://github.com/uhppoted/uhppote-cli#get-devices)
- [`get-device`](https://github.com/uhppoted/uhppote-cli#get-device)
- [`set-address`](https://github.com/uhppoted/uhppote-cli#set-address)
- [`get-time`](https://github.com/uhppoted/uhppote-cli#get-time)
- [`set-time`](https://github.com/uhppoted/uhppote-cli#set-time)
- [`get-door-delay`](https://github.com/uhppoted/uhppote-cli#get-door-delay)
- [`set-door-delay`](https://github.com/uhppoted/uhppote-cli#set-door-delay)
- [`get-door-control`](https://github.com/uhppoted/uhppote-cli#get-door-control)
- [`set-door-control`](https://github.com/uhppoted/uhppote-cli#set-door-control)
- [`get-listener`](https://github.com/uhppoted/uhppote-cli#get-listener)
- [`set-listener`](https://github.com/uhppoted/uhppote-cli#set-listener)
- [`get-status`](https://github.com/uhppoted/uhppote-cli#get-status)
- [`get-cards`](https://github.com/uhppoted/uhppote-cli#get-cards)
- [`get-card`](https://github.com/uhppoted/uhppote-cli#get-card)
- [`put-card`](https://github.com/uhppoted/uhppote-cli#put-card)
- [`delete-card`](https://github.com/uhppoted/uhppote-cli#delete-card)
- [`delete-all`](https://github.com/uhppoted/uhppote-cli#delete-all)
- [`get-time-profile`](https://github.com/uhppoted/uhppote-cli#get-time-profile)
- [`set-time-profile`](https://github.com/uhppoted/uhppote-cli#set-time-profile)
- [`clear-time-profiles`](https://github.com/uhppoted/uhppote-cli#clear-time-profile)
- [`get-time-profiles`](https://github.com/uhppoted/uhppote-cli#get-time-profiles)
- [`set-time-profiles`](https://github.com/uhppoted/uhppote-cli#set-time-profiles)
- [`record-special-events`](https://github.com/uhppoted/uhppote-cli#record-special-events)
- [`get-events`](https://github.com/uhppoted/uhppote-cli#get-events)
- [`get-event`](https://github.com/uhppoted/uhppote-cli#get-event)
- [`get-event-index`](https://github.com/uhppoted/uhppote-cli#get-event-index)
- [`set-event-index`](https://github.com/uhppoted/uhppote-cli#set-event-index)
- [`open`](https://github.com/uhppoted/uhppote-cli#open)
- [`listen`](https://github.com/uhppoted/uhppote-cli#listen)
- [`get-devices`](#get-devices)
- [`get-device`](#get-device)
- [`set-address`](#set-address)
- [`get-time`](#get-time)
- [`set-time`](#set-time)
- [`get-door-delay`](#get-door-delay)
- [`set-door-delay`](#set-door-delay)
- [`get-door-control`](#get-door-control)
- [`set-door-control`](#set-door-control)
- [`get-listener`](#get-listener)
- [`set-listener`](#set-listener)
- [`record-special-events`](#record-special-events)
- [`get-status`](#get-status)
- [`get-cards`](#get-cards)
- [`get-card`](#get-card)
- [`put-card`](#put-card)
- [`delete-card`](#delete-card)
- [`delete-all`](#delete-all)
- [`get-time-profile`](#get-time-profile)
- [`set-time-profile`](#set-time-profile)
- [`get-time-profiles`](#get-time-profiles)
- [`set-time-profiles`](#set-time-profiles)
- [`clear-time-profiles`](#clear-time-profiles)
- [`get-events`](#get-events)
- [`get-event`](#get-event)
- [`get-event-index`](#get-event-index)
- [`set-event-index`](#set-event-index)
- [`open`](#open)
- [`listen`](#listen)

ACL commands:

Expand Down Expand Up @@ -508,6 +509,34 @@ uhppote-cli [options] set-listener <device> <address:port>
405419896 true
```

#### `record-special-events`

Enables or disables events for door open, door closed and door button pressed for a single controller accessible on either the
local LAN or configured in the communal `uhppoted.conf` configuration (or custom configuration, if specified). The command
returns the result as a fixed width columnar table with:

- `serial number`
- `succeeded` _true/false_

```
uhppote-cli [options] record-special-events <device> <enable>
<device> (required) Controller serial number
<enable> (optional) Enables or disables door open, closed and button pressed events. Defaults to `true`
Options:
--config Sets the uhppoted.conf file to use for controller configurations
--bind Overrides the default (or configured) bind IP address for a command
--broadcast Overrides the default (or configured) broadcast IP address to which to send a command
--broadcast Overrides the default (or configured) listen IP address on which to listen for events
--timeout Sets the timeout for a response from a controller (default value is 2.5s)
--debug Displays verbose debugging information, in particular the communications with the UHPPOTE controllers
Example:
> uhppote-cli record-special-events 405419896 false
405419896 true
```

#### `get-status`

Retrieves the controller status for a single controller accessible on the local LAN (i.e. can receive and respond to UDP broadcasts) or configured in the communal `uhppoted.conf` configuration (or custom configuration, if specified). The command returns a fixed width columnar table with:
Expand Down Expand Up @@ -866,34 +895,6 @@ uhppote-cli [options] set-time-profiles <device ID> <TSV>
1. `set-time-profiles` does not clear existing time profiles from the controller i.e. although not recommended, profiles in the file can link to individually defined existing profiles.
2. There is no requirement for the profiles to be in any particular order e.g. `uhppote-cli` is capable of creating a time profile that is linked to a profile that is defined after it in the TSV file.

#### `record-special-events`

Enables or disables events for door open, door closed and door button pressed for a single controller accessible on either the
local LAN or configured in the communal `uhppoted.conf` configuration (or custom configuration, if specified). The command
returns the result as a fixed width columnar table with:

- `serial number`
- `succeeded` _true/false_

```
uhppote-cli [options] record-special-events <device> <enable>
<device> (required) Controller serial number
<enable> (optional) Enables or disables door open, closed and button pressed events. Defaults to `true`
Options:
--config Sets the uhppoted.conf file to use for controller configurations
--bind Overrides the default (or configured) bind IP address for a command
--broadcast Overrides the default (or configured) broadcast IP address to which to send a command
--broadcast Overrides the default (or configured) listen IP address on which to listen for events
--timeout Sets the timeout for a response from a controller (default value is 2.5s)
--debug Displays verbose debugging information, in particular the communications with the UHPPOTE controllers
Example:
> uhppote-cli record-special-events 405419896 false
405419896 true
```

#### `get-events`

Retrieves the start and end range of the events stored on a controller.
Expand Down
11 changes: 3 additions & 8 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
## v0.7.x

### IN PROGRESS

- [ ] Check card number field for get-event
- [ ] `grant` with time profile
- [ ] `set-schedule`
- [ ] `get-schedule`
## v0.7.0

- [x] `grant` with time profile
- [x] Add missing commands to README
- [x] Tabulate output for get-devices
- [x] Print device name for get-device(s)
Expand All @@ -29,6 +23,7 @@

## TODO

- [ ] Check card number field for get-event
- [ ] Route debugging to stderr
- [ ] get-events --fetch
- [ ] listener: retrieve and show actual events
Expand Down
4 changes: 2 additions & 2 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ module github.com/uhppoted/uhppote-cli
go 1.16

require (
github.com/uhppoted/uhppote-core v0.6.13-0.20210608173129-01558a7d3430
github.com/uhppoted/uhppoted-api v0.6.13-0.20210608173423-fca12dfcd076
github.com/uhppoted/uhppote-core v0.7.0
github.com/uhppoted/uhppoted-api v0.7.0
)
4 changes: 4 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ github.com/uhppoted/uhppote-core v0.6.13-0.20210608170549-b31238e77fe5 h1:lLL6QR
github.com/uhppoted/uhppote-core v0.6.13-0.20210608170549-b31238e77fe5/go.mod h1:trhONXGxYU0V5kOzBShTedYcRY98p9uV99JBZ7F1M0k=
github.com/uhppoted/uhppote-core v0.6.13-0.20210608173129-01558a7d3430 h1:YvuNZtwz/dEvS0n8mph8FXV5ow1h8T8Cwpbd7GrkCAg=
github.com/uhppoted/uhppote-core v0.6.13-0.20210608173129-01558a7d3430/go.mod h1:trhONXGxYU0V5kOzBShTedYcRY98p9uV99JBZ7F1M0k=
github.com/uhppoted/uhppote-core v0.7.0 h1:6x7GBZzbSv0D43UuCG1I8jvGPW+YmiWHr1G+VG8huHk=
github.com/uhppoted/uhppote-core v0.7.0/go.mod h1:trhONXGxYU0V5kOzBShTedYcRY98p9uV99JBZ7F1M0k=
github.com/uhppoted/uhppoted-api v0.6.13-0.20210520193707-b8f6e75a5502 h1:FcpLg4OnKpG8CZ9hOiOj7VjWf+d1xa7/9+tpeYDvgUo=
github.com/uhppoted/uhppoted-api v0.6.13-0.20210520193707-b8f6e75a5502/go.mod h1:iVjH27o5YIBr/iZqG5pZMHENuKUTZk67JEo7BdAnDGs=
github.com/uhppoted/uhppoted-api v0.6.13-0.20210524193322-a4dd68c940e2 h1:Vg81uIyan6aHnZIMtnOuFF3EI6XGzplqbDmzzkcSjBs=
Expand All @@ -44,5 +46,7 @@ github.com/uhppoted/uhppoted-api v0.6.13-0.20210608170802-70e2da27251a h1:C96KrG
github.com/uhppoted/uhppoted-api v0.6.13-0.20210608170802-70e2da27251a/go.mod h1:YIMdc3KNBw2Io6B1dlLt+VmIiF06VoVHL4yEXoJBmac=
github.com/uhppoted/uhppoted-api v0.6.13-0.20210608173423-fca12dfcd076 h1:91LWWDg/So0GVvK1HVIzQA24y1OGzKmmpmY0czQ1C9Y=
github.com/uhppoted/uhppoted-api v0.6.13-0.20210608173423-fca12dfcd076/go.mod h1:SKX07DPv1NUJvB3CUkLgq5v1LWgFzDHeJuDObqyLTDU=
github.com/uhppoted/uhppoted-api v0.7.0 h1:9/YV5R1POYz4upisDJYv7reul0FIu7Cxyd5gu0dhcDU=
github.com/uhppoted/uhppoted-api v0.7.0/go.mod h1:RqewY0tqV0hJ1m/0jePMi98d5NwrlH/yjfg68m6W7qE=
golang.org/x/sys v0.0.0-20210426230700-d19ff857e887 h1:dXfMednGJh/SUUFjTLsWJz3P+TQt9qnR11GgeI3vWKs=
golang.org/x/sys v0.0.0-20210426230700-d19ff857e887/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=

0 comments on commit a4f8af4

Please sign in to comment.