https://github.com/dennwc/inkview
Go SDK for Pocketbook
https://github.com/dennwc/inkview
golang pocketbook sdk
Last synced: 3 months ago
JSON representation
Go SDK for Pocketbook
- Host: GitHub
- URL: https://github.com/dennwc/inkview
- Owner: dennwc
- License: mit
- Created: 2017-09-02T16:10:31.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-10-24T09:58:52.000Z (over 3 years ago)
- Last Synced: 2025-03-18T08:11:21.087Z (3 months ago)
- Topics: golang, pocketbook, sdk
- Language: C
- Size: 28.3 KB
- Stars: 37
- Watchers: 1
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go SDK for Pocketbook
Unofficial Go SDK for Pocketbook based on libinkview.
Supports graphical user interfaces and CLI apps.
## Build a CLI app
Standard Go compiler should be able to cross-compile the binary
for the device (no need for SDK):
```
GOOS=linux GOARCH=arm GOARM=5 go build main.go
```
Note that some additional workarounds are necessary if you want to access
a network from your app. In this case you may still need SDK.
Although this binary will run on the device, you will need a third-party
application to actually see an output of you program (like
[pbterm](http://users.physik.fu-berlin.de/~jtt/PB/)).
The second option is to wrap the program into `RunCLI` - it will
emulate terminal output and write it to device display.
## Preparation - Build or pull the Docker Image
You can pull a docker images from dockerhub:
```bash
docker pull 5keeve/pocketbook-go-sdk:6.3.0-b288-v1
```
To build this image on your own, feel free to use `docker-compose.yaml`.
```bash
docker-compose build
```
This will create a `pb-go` service which can be used to compile a go program.
Adjust the `source` path in `docker-compose.yaml` to your needs.
With the current settings you can compile the test programs.
E.g.:
```bash
docker-compose run --rm pb-go build ./sqlitetst.dir/sqlitetst.go
```
**Note** In order to see some output for this, you need to run in using something like pbterm.
If you just start it without pbterm you can verify successful execution by attaching your
device to your computer and check for the presence of the file `sqlite-database.db`.
```bash
docker-compose run --rm pb-go build ./devinfo/main.go
```
Alternatively, after building the image, `docker` can be used to compile without adjusting the file.
## Build an app with UI
To build your app or any example, run (requires Docker):
```bash
cd ./examples/sqlitetst.dir/
docker run --rm -v $PWD:/app dennwc/pocketbook-go-sdk build -o sqlitetst.app
```
```bash
cd ./examples/devinfo/
docker run --rm -v $PWD:/app dennwc/pocketbook-go-sdk
mv app devinfo.app
```
You may also need to mount GOPATH to container to build your app:
```
docker run --rm -v $PWD:/app -v $GOPATH:/gopath dennwc/pocketbook-go-sdk
```
To run an binary, copy it into `applications/app-name.app` folder
on the device and it should appear in the applications list.
## Notes on networking
By default, device will try to shutdown network interface to save battery,
thus you will need to call SDK functions to keep device online (see `KeepNetwork`).
Also note that establishing TLS will require Go to read system
certificate pool that might take up to 30 sec on some devices and will
lead to TLS handshake timeouts. You will need to call `InitCerts` first
to fix the problem.
IPv6 is not enabled on some devices, thus a patch to Go DNS lib is required
to skip lookup on IPv6 address (SDK already includes the patch).
Similar problems may arise when trying to dial IPv6 directly.
## Notes on workdir
Application will have a working directory set to FS root, and not to
a parent directory.
To use relative paths properly change local dir to a binary's parent
directory: `os.Chdir(filepath.Dir(os.Args[0]))`.