Labrador/README.md

59 lines
2.5 KiB
Markdown
Raw Normal View History

2018-02-06 03:58:51 +00:00
# What is it?
The EspoTek Labrador is an open-source board that converts your PC, Raspberry Pi or Android Smartphone and into a full-featured electronics lab bench, complete with oscilloscope, signal generator and more.
More information available at:
http://espotek.com/labrador
2018-02-06 03:58:51 +00:00
This repo hosts all of the software and hardware that makes Labrador possible.
2018-02-06 04:02:33 +00:00
# Documentation and Software
2019-04-12 02:47:43 +01:00
To download binary (executable) versions of the software, go to:
2018-02-06 03:58:51 +00:00
https://github.com/espotek/labrador/releases
2019-04-12 02:47:43 +01:00
The software is re-built automatically each time I make a change to the source code. I recommend always downloading the latest win32, osx-dmg or linux-appimage version, depending on whether you're on Windows, macOS or Linux. Raspberry Pi downloads are not currently automatically built, but an older version is provided at the link above.
2018-02-06 03:58:51 +00:00
2019-04-12 02:47:43 +01:00
For the documentation, please visit:
2018-02-06 03:58:51 +00:00
https://github.com/espotek/labrador/wiki
2019-06-10 06:47:07 +01:00
# Additional Extras
There is also a 3D printable case available at Thingiverse, courtesy of SpaceBex:
https://www.thingiverse.com/thing:3188243
2018-04-10 07:31:25 +01:00
# Licence
All software files are licenced under GNU GPL v3. https://www.gnu.org/licenses/gpl.html
All hardware files (schematics, PCB) are licenced under Creative Commons 4.0 (CC BY-NC-SA). https://creativecommons.org/licenses/by-nc-sa/4.0/
2018-02-06 04:02:33 +00:00
# Building from Source
2019-04-12 02:44:03 +01:00
I use Qt Creator to build the software interface.
https://www.qt.io/download-open-source/
Open Desktop_Interface/Labrador.pro, then Clean All -> Run qmake -> Build All.
If you're on Linux (including Raspberry Pi), then you can also build the software from source by cloning the repo, cd'ing to the Desktop_Interface directory then running:
2018-07-19 10:55:19 +01:00
```
qmake
make
sudo make install
```
2019-04-12 02:44:03 +01:00
Then, to launch, just type `labrador` into the terminal.
2017-10-21 07:38:13 +01:00
2018-12-28 03:17:01 +00:00
To build the AVR software, I use Atmel Studio 7. Just load up the .atsln and push F7. You can use `avr-gcc` if you don't want to install a full IDE.
2017-10-21 07:38:13 +01:00
2018-07-19 10:55:19 +01:00
The PCB files can be edited in KiCAD 4.0.
# Known bugs.
2019-04-12 02:44:03 +01:00
Most of the main bugs from the pre-launch period have now been fixed, including synchronisation issues.
2018-02-06 03:58:51 +00:00
Please open an issue if you're aware of any in particular.
# Collaboration
2018-02-06 03:58:51 +00:00
If you want to make any suggestions, or better yet, submit some code, please do so here at GitHub.
2018-02-06 04:02:33 +00:00
2018-02-06 03:58:51 +00:00
Suggestions and feature requests belong on the "Issues" page.
2018-02-06 04:02:33 +00:00
2018-12-27 00:52:56 +00:00
For code submissions, look into Pull Requests.
2017-10-21 07:32:38 +01:00
2018-12-27 00:52:56 +00:00
If you just want to say hello and remind me that people are actually using my product (or if you just don't want to make a GitHub account), please email admin@espotek.com
2018-02-06 04:02:33 +00:00
2019-04-12 02:44:03 +01:00
Thanks to all.
~Chris