Skip to content

Commit

Permalink
some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sombriks committed Apr 20, 2024
1 parent 51d98dd commit 1a738d0
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 2 deletions.
8 changes: 8 additions & 0 deletions docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

Noteworthy changes

## 2024-04-20

## 0.4.3

- added a more expressive message in exceptions, bubbling the
[errno](https://en.wikipedia.org/wiki/Errno.h) value in message of thrown
exception, many thanks to @splitice

## 2024-04-06

## 0.4.2
Expand Down
29 changes: 27 additions & 2 deletions docs/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,11 +78,36 @@ make # solve several missing dependencies
After compiling we can now load the new kernel module:

```bash
# TBD
```

## Functionality parity

This is the api parity table:

| Function | C | Node |
| -------- | - | ---- |
| Description | Scope | C/C++ | Node |
|-------------------------------|---------------|--------------------------------|-----------------------|
| get line's instant value | Miscellaneous | gpiod_ctxless_get_value | getInstantLineValue |
| set line's instant value | Miscellaneous | gpiod_ctxless_set_value | setInstantLineValue |
| get number of lines in a chip | Chip | gpiod_chip_num_lines | getNumberOfLines |
| get chip name | Chip | gpiod_chip_name | getChipName |
| get chip label | Chip | gpiod_chip_label | getChipLabel |
| | Line | gpiod_line_offset | getLineOffset |
| | Line | gpiod_line_name | getLineName |
| | Line | gpiod_line_consumer | getLineConsumer |
| | Line | gpiod_line_get_value | getValue |
| | Line | gpiod_line_set_value | setValue |
| | Line | gpiod_line_request_input | requestInputMode |
| | Line | gpiod_line_request_input_flags | requestInputModeFlags |
| | Line | gpiod_line_request_output | requestOutputMode |
| | Line | gpiod_line_release | release |

## Other implementations

Those are other notable libgpiod wrapper implementations to take as reference.

### Official C++ binding

### Official Python binding

### Golang binding
40 changes: 40 additions & 0 deletions node-libgpiod.geany
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
[editor]
line_wrapping=false
line_break_column=72
auto_continue_multiline=true

[file_prefs]
final_new_line=true
ensure_convert_new_lines=false
strip_trailing_spaces=false
replace_tabs=false

[indentation]
indent_width=4
indent_type=1
indent_hard_tab_width=8
detect_indent=false
detect_indent_width=false
indent_mode=2

[project]
name=node-libgpiod
base_path=/home/sombriks/git/node-libgpiod
description=

[long line marker]
long_line_behaviour=1
long_line_column=72

[files]
current_page=6
FILE_NAME_0=615;C++;0;EUTF-8;1;1;0;%2Fhome%2Fsombriks%2Fgit%2Fnode-libgpiod%2Fsrc%2Fmain.cc;0;4
FILE_NAME_1=158;C++;0;EUTF-8;1;1;0;%2Fhome%2Fsombriks%2Fgit%2Fnode-libgpiod%2Fsrc%2Fmisc.cc;0;4
FILE_NAME_2=0;C++;0;EUTF-8;1;1;0;%2Fhome%2Fsombriks%2Fgit%2Fnode-libgpiod%2Fsrc%2Fmisc.hh;0;4
FILE_NAME_3=0;C++;0;EUTF-8;1;1;0;%2Fhome%2Fsombriks%2Fgit%2Fnode-libgpiod%2Fsrc%2Fline.hh;0;4
FILE_NAME_4=0;C++;0;EUTF-8;1;1;0;%2Fhome%2Fsombriks%2Fgit%2Fnode-libgpiod%2Fsrc%2Fline.cc;0;4
FILE_NAME_5=0;C++;0;EUTF-8;1;1;0;%2Fhome%2Fsombriks%2Fgit%2Fnode-libgpiod%2Fsrc%2Fchip.hh;0;4
FILE_NAME_6=639;C++;0;EUTF-8;1;1;0;%2Fhome%2Fsombriks%2Fgit%2Fnode-libgpiod%2Fsrc%2Fchip.cc;0;4

[VTE]
last_dir=/home/sombriks
2 changes: 2 additions & 0 deletions src/line.hh
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ class Line : public Nan::ObjectWrap {

static NAN_METHOD(requestInputMode);
static NAN_METHOD(requestInputModeFlags);

static NAN_METHOD(requestOutputMode);

static NAN_METHOD(release);

static Nan::Persistent<v8::Function> constructor;
Expand Down

0 comments on commit 1a738d0

Please sign in to comment.