common

package

v0.0.0-...-09b491c Latest Latest Go to latest Published: May 9, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package common provides functionality shared by all Remarkable devices

View Source

const (
	ExtPDF  = ".pdf"
	ExtEPUB = ".epub"
)

Supported file extensions

This section is empty.

This section is empty.

type Device struct {
	// contains filtered or unexported fields
}

Device denotes a generic device (independent of exact model)

func NewDevice(dataPath string) *Device

NewDevice instantiates a new generic device

func (d *Device) Download(id string) (*device.Document, error)

Download retrieves a file (PDF / ePUB) from the device tree

func (d *Device) FileTree() (*device.Tree, error)

FileTree returns a tree structure of all files on the device

func (d *Device) Upload(docs ...device.Document) error

Upload uploads a file (PDF / ePUB) to the device tree