murray-lang / Babuino

Babuino root
2 stars 3 forks source link

Examples folder #1

Open greenonline opened 6 years ago

greenonline commented 6 years ago

A couple of issues that I've found whilst trying to install the sketch and libraries:

  1. It would probably be better to put the babuino/babuino.ino sketch in a directory called examples in the libraries/Babuino directory (like so libraries/Babuino/examples/babuino/babuino.ino) - rather than requiring the user to copy twice (once the Babuino library to the Libraries folder and once for the babuino/babuino.ino sketch to the sketchbook). The sketch, if it were in an examples directory, once opened in Arduino (via the Examples submenu), can then be saved to the user's sketchbook is so required. However, it is unlikely that the user will need to modify the sketch, as they should just be able to upload it as is, and therefore having it as just an uploadable example conained within the library is fine.
  2. If the https://github.com/murray-lang/Babuino/tree/master/Firmware/Arduino/libraries/Babuino were made to be a top level repository itself, rather than being buried in a number of directories, then the user would be able to download the Zip file and add it to Arduino IDE Libraries directly (as a zip using the menu option) rather than having to download the full repository, unzip that on the desktop and then manually copy over the library (as well as the babuino.ino sketch, if the above "examples directory" suggestion is not done) separately. As it stands there is no github option to download the Babuino library as a standalone zip. (see this library as an example, https://github.com/greenonline/SSD1306_OLED_HW_I2C_PRINT_LIB)
  3. I get the following error in Arduino IDE 1.8.3
Serial.h: No such file or directory
 #include <Serial.h>`

The line #include <Serial.h> in Babuino.h needs to be commented out. It is no longer required...

//#include <Serial.h>
  1. In EEPROMStorage.cpp, the following change is required:
#ifdef _HAS_EEPROM_
//#include "../EEPROM/EEPROM.h"
#include <EEPROM.h>
#endif

That is to say, comment out

#include "../EEPROM/EEPROM.h"

as ../EEPROM/EEPROM.h can not be found, and replace with

#include <EEPROM.h>

as is used at the top of babuino.ino. If you don't replace #include "../EEPROM/EEPROM.h" (and just comment it out), then you will obviously get EEPROM is not declared errors:

/Volumes/Home/Users/user/Documents/Arduino/libraries/Babuino/EEPROMStorage.cpp:18:8: error: 'EEPROM' was not declared in this scope
  val = EEPROM.read((int)address);

At least it compiles now :-)

If any of that is not clear, please get back to me.

murray-lang commented 6 years ago

Hi greenonline,

I'm very pleased that somebody has taken an interest, and apologise for any of your time wasted on such issues. But please bear in mind that the Arduino IDE user source structure has changed since this code was written (note the dates). Maybe there were better ways even back then, but there are certainly better ways now.

Work continued on this project, but under a new guise of "Weta" - a very large cricket from New Zealand. I changed the name to remove any hint that it was just Arduino, because I wanted it cross-platform.

There are ports to ESP-32 and ESP-8266. To make porting easier, I changed it to pure C code (that was an interesting adjustment in mindset!) Have a look at my GitHub repositories. There'll be more pain and suffering for you with that stuff (c:

Anyway, please don't hesitate to ask questions. Life/work has taken over, and I haven't touched any of it for some time.

Cheers, Murray

greenonline notifications@github.com wrote:

A couple of issues that I've found whilst trying to install the sketch and libraries:

It would probably be better to put the babuino/babuino.ino sketch in a directory called examples in the libraries/Babuino directory - rather than requiring the user to copy twice (once the library to the Libraries folder and once for the sketch to the sketchbook). The sketch, if it were in an examples directory, once opened in Arduino (via the Examples submenu), can then be saved to the user's sketchbook is so required. However, it is unlikely that the user will need to modify the sketch, as they should just be able to upload it as is, and therefore having it as just an uploadable example conained within the library is fine.If the https://github.com/murray-lang/Babuino/tree/master/Firmware/Arduino/libraries/Babuino were made to be a top level repository itself, rather than being buried in a number of directories, then the user would be able to download the Zip file and add it to Arduino IDE Libraries directly (as a zip using the menu option) rather than having to download the full repository, unzip that on the desktop and then manually copy over the library (as well as the Babuino.ino sketch, if the above "examples" suggestion is not done) separately. As it stands there is no github option to download the Babuino library as a standalone zip. (see this library as an example, https://github.com/greenonline/SSD1306_OLED_HW_I2C_PRINT_LIB)I get the following error in Arduino IDE 1.8.3

Serial.h: No such file or directory #include

The line #include in Babuino.h needs to be commented out. It is no longer required...

In EEPROMStorage.cpp, the following change is required: #ifdef _HASEEPROM //#include "../EEPROM/EEPROM.h" #include #endif

At least it compiles now :-)

If any of that is not clear, please get back to me.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

{"api_version":"1.0","publisher":{"api_key":"05dde50f1d1a384dd78767c55493e4bb","name":"GitHub"},"entity":{"external_key":"github/murray-lang/Babuino","title":"murray-lang/Babuino","subtitle":"GitHub repository","main_image_url":"https://cloud.githubusercontent.com/assets/143418/17495839/a5054eac-5d88-11e6-95fc-7290892c7bb5.png","avatar_image_url":"https://cloud.githubusercontent.com/assets/143418/15842166/7c72db34-2c0b-11e6-9aed-b52498112777.png","action":{"name":"Open in GitHub","url":"https://github.com/murray-lang/Babuino"}},"updates":{"snippets":[{"icon":"DESCRIPTION","message":"Examples folder (#1)"}],"action":{"name":"View Issue","url":"https://github.com/murray-lang/Babuino/issues/1"}}}

greenonline commented 6 years ago

Hi Murray

Thanks for the reply. :-)

On Wed, 28 Mar 2018 at 03:11, Murray Lang notifications@github.com wrote:

Hi greenonline,

I'm very pleased that somebody has taken an interest, and apologise for any of your time wasted on such issues. But please bear in mind that the Arduino IDE user source structure has changed since this code was written (note the dates). Maybe there were better ways even back then, but there are certainly better ways now.

Work continued on this project, but under a new guise of "Weta" - a very large cricket from New Zealand. I changed the name to remove any hint that it was just Arduino, because I wanted it cross-platform.

There are ports to ESP-32 and ESP-8266. To make porting easier, I changed it to pure C code (that was an interesting adjustment in mindset!) Have a look at my GitHub repositories. There'll be more pain and suffering for you with that stuff (c:

Anyway, please don't hesitate to ask questions. Life/work has taken over, and I haven't touched any of it for some time.

Cheers, Murray

greenonline notifications@github.com wrote:

A couple of issues that I've found whilst trying to install the sketch and libraries:

It would probably be better to put the babuino/babuino.ino sketch in a directory called examples in the libraries/Babuino directory - rather than requiring the user to copy twice (once the library to the Libraries folder and once for the sketch to the sketchbook). The sketch, if it were in an examples directory, once opened in Arduino (via the Examples submenu), can then be saved to the user's sketchbook is so required. However, it is unlikely that the user will need to modify the sketch, as they should just be able to upload it as is, and therefore having it as just an uploadable example conained within the library is fine.If the https://github.com/murray-lang/Babuino/tree/master/Firmware/Arduino/libraries/Babuino were made to be a top level repository itself, rather than being buried in a number of directories, then the user would be able to download the Zip file and add it to Arduino IDE Libraries directly (as a zip using the menu option) rather than having to download the full repository, unzip that on the desktop and then manually copy over the library (as well as the Babuino.ino sketch, if the above "examples" suggestion is not done) separately. As it stands there is no github option to download the Babuino library as a standalone zip. (see this library as an example, https://github.com/greenonline/SSD1306_OLED_HW_I2C_PRINT_LIB)I get the following error in Arduino IDE 1.8.3

Serial.h: No such file or directory #include

The line #include in Babuino.h needs to be commented out. It is no longer required...

In EEPROMStorage.cpp, the following change is required: #ifdef _HASEEPROM //#include "../EEPROM/EEPROM.h" #include #endif

At least it compiles now :-)

If any of that is not clear, please get back to me.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

{"api_version":"1.0","publisher":{"api_key":"05dde50f1d1a384dd78767c55493e4bb","name":"GitHub"},"entity":{"external_key":"github/murray-lang/Babuino","title":"murray-lang/Babuino","subtitle":"GitHub repository","main_image_url":" https://cloud.githubusercontent.com/assets/143418/17495839/a5054eac-5d88-11e6-95fc-7290892c7bb5.png ","avatar_image_url":" https://cloud.githubusercontent.com/assets/143418/15842166/7c72db34-2c0b-11e6-9aed-b52498112777.png","action":{"name":"Open in GitHub","url":"https://github.com/murray-lang/Babuino"}},"updates":{"snippets":[{"icon":"DESCRIPTION","message":"Examples folder (#1)"}],"action":{"name":"View Issue","url":" https://github.com/murray-lang/Babuino/issues/1"}}}

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/murray-lang/Babuino/issues/1#issuecomment-376736689, or mute the thread https://github.com/notifications/unsubscribe-auth/ALKv7jilrkSRA6U5n41pYmTptXQNClRAks5tivFogaJpZM4S85VG .