SSSICK/BUOY: Difference between revisions

From WWWIKI
 
(276 intermediate revisions by the same user not shown)
Line 1: Line 1:
=Introduction=
=Introduction=


Buoy is an all-in-one data-logging and tuning tool for the SSSMCK (SSSQUID MAF CONVERSION KIT). It is in beta stages and as such may have bugs. Please [https://sssquid.com/v3/contact contact us] with any bugs you may encounter.
Buoy is an all-in-one data-logging and tuning tool for the SSSICK (SSSQUID INPUT CONVERSION KIT).


This tool was developed in and for Linux first. The Windows port is in very early stages and will naturally have more bugs than the Linux flavor. There is no version for Mac OSX and we do not have any plans to ever release a version for that OS.
From Buoy you can monitor live data (airflow rate and intake air temperature), log these parameters to a file, and tune the SSSICK for different input and output sensors.
 
Expect new software to be released regularly. You can check for and download any updates from within Buoy, or by checking this page and downloading it directly.
 
This tool was developed in and for Linux first, however Windows versions are available as well. We have no plans to develop an OSX version.
 
An Android version will shortly be available for the Bluetooth-enabled hardware (revisions R019 and newer). We have no plans to develop an iOS app.
 
Please [https://sssquid.com/v3/contact contact us] with any bugs you may encounter.


Expect new software to be released regularly. We have not implemented any auto-update functions yet. Please bookmark this page to get quick access to the latest software.


=Download=
=Download=
Latest Version: 0.18.07
*Windows
**32-bit (JRE required) - [https://sssquid.com/strg/sssmck/buoy/buoy-001807-win32.zip Download]
**64-bit (recommended for most users! Pre-compiled JRE included) - [https://sssquid.com/strg/sssmck/buoy/buoy-001807-win64.zip Download]
*Linux
**32-bit - [https://sssquid.com/strg/sssmck/buoy/buoy-001807-lin32.tar Download]
**64-bit - [https://sssquid.com/strg/sssmck/buoy/buoy-001807-lin64.tar Download]
**arm32 - coming soon, please contact for early access
**arm64 - coming soon, please contact for early access


Previous versions available by request, though you should most likely be using the latest version!
The software is updated regularly. You can generally expect at least a few updates per month as we add more features and make more improvements. Please make sure to click "Check for updates" in the menu bar occasionally to stay updated!
 
==Latest Release==
 
This software version represents a rather large change to how most things work within Buoy in comparison with the last public release (0.20). It is compatible with all hardware R015 and newer. We will be adding further backwards compatibility in the future!
 
Version: 0.21.1203 (Released: 2024.04.08)
 
*'''Linux''' 64-bit
**[https://content.sssquid.com/sssick/buoy/Buoy_0_21_1203_Linux.tar.gz DOWNLOAD]
**[https://drive.google.com/file/d/1A4L6km9LTU8PJ3zfaoA0b1Cq6CA49Veu/view?usp=sharing MIRROR DOWNLOAD]
 
*'''Windows''' 64-bit
**[https://content.sssquid.com/sssick/buoy/Buoy_0_21_1203_Windows.zip DOWNLOAD]
**[https://drive.google.com/file/d/1JKi2tx2-HZ_nOklLKy9Lg4UGVgOEx-EV/view?usp=sharing MIRROR DOWNLOAD]
 
 
If you have a system that is NOT based on AMD/Intel 64-bit processors, we can compile the application to work with other architectures (such as ARM). Since this is so rare, we don't compile every single version for these particular systems. Please contact us for downloads! However, for the 99% of you who are using Intel- or AMD-based 64-bit processors, the above downloads will work perfect!
 
For users that want to flash updated firmware to their kit: please consult the [[SSSICK/BUOY/FLASHING|FLASHING]] page
 
[https://content.sssquid.com/sssick/buoy/changelog.html View the 0.21 changelog]


[[SSSMCK/BUOY/Version_History|Version History]]
==Previous version (0.20)==


==Installation==
We offer a previous version of the software for those that prefer the multi-window UI. We may continue to add support for the latest hardware and firmware versions, thought it won't be updated as often as the latest version of Buoy.
This program is designed to be portable -- there is no installation necessary. Simply extract the compressed folder contents to its own directory and run "Buoy.sh" (Linux) or "Buoy.exe" (Windows).


For the 32-bit Windows version of Buoy, the necessary JRE (Java Runtime Environment) is not pre-packaged. You may need to install the JRE if you haven't already: [https://docs.oracle.com/goldengate/1212/gg-winux/GDRAD/java.htm Java JRE]. The JRE is pre-packaged on the 64-bit version (what most everyone will be using). Unless you are running an older 32-bit version of Windows (like 32-bit XP), it is recommended to use the 64-bit version.
Current Version: 0.20.0507 (Released: 2023/04/25)


For Linux users, Java is required to run but is not prepackaged. Many flavors of Linux will come with the necessary runtime environments pre-installed, but if you're not sure you can check with your package manager.
* LINUX 64-bit
**[https://content.sssquid.com/sssmck/buoy/Buoy_0_20_0507_Linux.tar.gz DOWNLOAD]
**[MIRROR DOWNLOAD]
* WINDOWS 64-bit
**[https://content.sssquid.com/sssmck/buoy/Buoy_0_20_0507_Windows.zip DOWNLOAD]
**[MIRROR DOWNLOAD]


==Drivers==
Previous Version: 0.20.0506 (Released: 2023/03/14)
Most flavors of Linux will come pre-installed with the necessary drivers.


For Windows, you may need to install the standard FTDI D2XX drivers available at the following link: [https://ftdichip.com/drivers/d2xx-drivers/ FTDI D2XX Download Page]
* LINUX 64-bit
**[https://content.sssquid.com/sssmck/buoy/Buoy_0_20_0506_Linux.tar.gz DOWNLOAD]
**[https://drive.google.com/file/d/1fC0kIkGNJs-HVbDbS7BTGlSKbzIN8log/view?usp=drive_link MIRROR DOWNLOAD]
* WINDOWS 64-bit
**[https://content.sssquid.com/sssmck/buoy/Buoy_0_20_0506_Windows.zip DOWNLOAD]
**[https://drive.google.com/file/d/1zIBfnrNNJLVRqUezEwmQovifJ7VFnPwd/view?usp=drive_link MIRROR DOWNLOAD]  


=Interface=
If you have a system that is NOT based on AMD/Intel 64-bit processors, we can compile the application to work with other architectures (such as ARM). Since this is so rare, we don't compile every single version for these particular systems. Please contact us for downloads! However, for the 99% of you who are using Intel- or AMD-based 64-bit processors, the above downloads will work perfect!
*Main
**Setup port, flash firmware, and view diagnostic information.
*Live Dash
**View and log live airflow data.
*Log Replay
**View previously recorded logs with many ways to manipulate and filter the data.


=Usage=
[https://content.sssquid.com/sssmck/buoy/changelog.html View the 0.20 changelog]


==Connecting==
==Older version (0.18)==
This version works exclusively with hardware versions R003 through R018. It will not work with anything newer, or any versions using any firmware past 0182099.


With the top cover removed, you will need to find a 6-pin header. This is where the logging/flashing module will be plugged.
Latest Stable Version: 0.18.09 (Released: 2021/11/05)
*Windows
**32-bit (JRE required) - [https://content.sssquid.com/sssmck/buoy/old/buoy-01809-win32.zip Download]
**64-bit (recommended for most users! Pre-compiled JRE included) - [https://content.sssquid.com/sssmck/buoy/old/buoy-01809-win64-wjre.zip Download]
**64-bit (JRE required) - [https://content.sssquid.com/sssmck/buoy/old/buoy-01809-win64.zip Download]
*Linux
**32-bit - [https://content.sssquid.com/sssmck/buoy/old/buoy-01809-lin32.tar Download]
**64-bit - [https://content.sssquid.com/sssmck/buoy/old/buoy-01809-lin64.tar Download]


[[File:Loggingmoduleport.jpg|center|thumbnail]]
"JRE pre-compiled" vs "JRE required":
JRE stands for Java Runtime Environment. It is what allows you to run Java applications. This is an extremely common thing to have installed. Many applications that require it will install it for you, or may point you to the right download page to install it yourself. Similarly, many operating systems (mostly the major Linux flavors) will come with JRE pre-installed.


Plug in your logging/flashing module. It can only be inserted in one direction.
We offer two versions for download, JRE required and JRE pre-compiled. "JRE required" offer a vastly smaller download size for people who already have the JRE installed. "JRE pre-compiled" will download Buoy with JRE included within the application itself, but will therefore be a much larger file (about 200 MB compared to the much smaller 40 MB "JRE required" download).


[[File:Loggingmoduleconnected.jpg|center|thumbnail]]
If you are unsure what JRE is, if you have it, or what you should do -- the best idea would be to download the JRE pre-compiled version and not worry about it.  


Connect the USB cable to your computer. If you are logging, please skip the next step.
Previous versions available by request, though you should most likely be using the latest version!


ONLY if you are flashing the module!: it is recommended to use the USB power. You can do this by moving the "REG-USB" jumper from the "REG" side to the "USB" side as pictured below:
SSSICK firmware versions before R01807 may not plot data at the correct rate for the Buoy software versions 0.18.07 and newer, please [https://sssquid.com/v3/contact contact us] for the latest firmware!


[[File:Usbpowerselected.jpg|center|thumbnail]]
==Hardware R011 and Older==


Once you finish flashing, please make sure to move this jumper back to the "REG" side before continuing use on your vehicle.
Due to the complications of command-line interaction with the older units, we've taken down a lot of the instructions. However, we are happy to help anyone that needs help with their R011 or older hardware, just email us! info@sssquid.com


On the "Main" tab you will find the connection and flashing options.
We can provide the latest firmware rewritten for the older hardware versions, which will make it compatible with the latest versions of Buoy.


[[File:Buoy001804_main.png|center|thumbnail|600px]]
==Archive==
While we do recommend using the latest software, previous versions of each major release are available in our archives:


First you will need to select the correct port. Click on "Select Port" and you will be presented with a list of available ports.
[[SSSICK/BUOY/ARCHIVE|Version Archive]]


If you are unsure of which port the SSSMCK is connected through, you can simply disconnect the device and reconnect it to see which port is added and removed. The list automatically updates.


[[File:Buoy001804_portselected.png|center|thumbnail|600px]]
=Installation=
This program is designed to be portable -- there is no installation necessary.


Once the port is selected, click "Connect". It will take 2 seconds to connect, do not repeatedly click the "Connect" button during this time period. The SSSMCK should connect and automatically start sending airflow data. If data is not graphed on the "Live Dash" page, you can try disconnecting and reconnecting.
All you will have to do is extract the files from the .zip (Windows) or .tar.gz (Linux) file to their own directory, then double-click "Buoy.exe" for Windows, or for Linux "Buoy.sh".


==Data-logging==
For some Linux distributions, you may have to right-click and select "Run as a Program":
Once connected the SSSMCK should automatically begin transmitting airflow data to the program. This is displayed in kilograms per hour (Kg/Hr).


[[File:BUOY001804_LIVEGRAPH.png|thumbnail|center|600px]]
[[File:Run as program.png]]


On this page you can set an output file. Use the file extension ".csv" for logs (this file extension should automatically be added, but there is a bug in Windows where if your file path has one or more periods it may not be automatically added).
Linux users, if your Buoy.sh file will not run, you may need to set the correct executable permissions for the file. This can be done by opening a terminal window, navigating to the folder that contains "Buoy.sh", and running the following command:


Once you have set the output file, you may begin logging by selecting "Start Recording". Once you are finished recording, select "Stop Recording" or simply close the program.
<code>chmod +x Buoy.sh</code>


There are many ways to display the data, as a line (recommended and default), as dots, or as bars. The rest of the options are primarily for further diagnostics when necessary, but should not be needed or used by most users.
Now try running Buoy.sh again. Simple as that!


===Log Replay===
==Drivers==
If you would like to view previously recorded logs, you can open them a number of ways. They are output as simple CSV files (Comma Separated Values). These can be read by programs such as OpenOffice/LibreOffice Calc, Microsoft Excel, or within Buoy.


To open a previously recorded log, select "Open CSV File" and browse to the folder where the log was recorded. Select and open the log to populate the graph.
All drivers are now pre-packaged. There should not be any need to install additional drivers.


[[File:BUOY001804_LOGREPLAY.png|thumbnail|center|600px]]
You only need drivers when flashing using the USB dongle in older versions. You can get these drivers and read more about flashing on the [[SSSICK/BUOY/FLASHING|Flashing page HERE]].


You can manipulate the data, apply filters, change how it is displayed, and more by using the "Graph Options" and "Data Manipulation" sections.
=Usage=


==Flashing==
[[SSSICK/BUOY/Usage/SW0_21|Software 0.21]]


On the "Main" page, make sure you have the proper port selected and are connected to the SSSMCK. Under "Firmware Control" click on "Select Firmware" to be presented with a file explorer. Navigate to the firmware (file extension ".mckf") you wish to flash to the device and select it.
[[SSSICK/BUOY/Usage/SW0_20|Software 0.20]]


[[File:R001804_flashing.png|center|thumbnail|600px]]
Older software:


Once you have chosen the firmware, the button underneath it will change to "Flash Firmware". Click this button to flash the firmware. A success or failure message will be displayed in the console log.
[[SSSICK/BUOY/Usage/SW0_19|Software 0.19]]


==Configuration==
[[SSSICK/BUOY/Usage/SW0_18|Software 0.18]]
You can configure most of the program's settings, such as the theme and interface scaling, by clicking on the settings icon in the upper-right side of the application.


=Firmware=
=Firmware=


".MCKF" files contain the calibrations for the MAF and VAM selected. Since we are constantly releasing new versions, please [https://sssquid.com/v3/contact contact us] with your required MAF and VAM combination and your hardware version, we will reply with a download of the latest available software.
As of firmware 0190923 and newer, flashing to a new MAF/MAP/TPS/VAM can be done independently and wirelessly through Buoy and without the need to flash the unit with the hardware flashing module. Newer hardware  versions do not include a firmware flashing dongle as it's no longer necessary. We are happy to flash your SSSICK to the latest firmware at NO COST, please contact us to get setup!
 
For older hardware we wanted to include the ability to update the firmware as it was continually developed in order to support new features. Therefore a flashing dongle was included. While it's not necessary to run the latest firmware, you may notice improvements by using it. If you'd like a copy of the latest firmware, please email us with your order number or hardware version and we'll get you setup as soon as possible. If you are on older hardware (specifically R018 or older) then updating the latest FW is highly recommended and it will allow you to tune within Buoy. Please contact us for downloads [email protected]!
 
".MCKF" files contain the firmware for your specific hardware version. Since we are constantly releasing new versions, please [https://sssquid.com/v3/contact contact us] with your required MAF and VAM combination and your hardware version, we will reply with a download of the latest available software.
 
All units ship with the proper and latest available firmware for your hardware and are pre-programmed for your selected MAF and VAM, so there is no need to flash a new unit unless you need the newest features, there are fixes, or the latest Buoy software requires it.
 
As of September 13th, 2022 a new firmware version is available with vastly improved filtering and overall operation. We have produced retro firmware for hardware R013 through R019. All hardware versions R020 already contain the latest firmware. If you have older hardware and want the latest features, please contact us for firmware downloads!
 
[[SSSICK/BUOY/FLASHING|FLASHING INSTRUCTIONS]]
 
=Tuning=
Read more on the [[SSSICK/BUOY/Tuning|Tuning page]]!
=Connection=
 
You can find tutorials on how to connect and troubleshoot connections on various operating systems here: [[SSSICK/BUOY/Connection]]


All units ship with the proper and latest available firmware for your selected MAF and VAM, so there is no need to flash a new unit unless you are changing vehicles/tunes/MAFs, there are fixes, or the latest software requires it.
=Data Collection Policy=
At no point does Buoy collect any user data. No data is collected, recorded, or sent to us in any fashion. The only time Buoy ever contacts our servers is when you manually click the "Check for update" button, or you download an update. No personalized or identifiable data is collected in doing this, but your public IP is logged because it's a necessary process in order to actually make contact with our servers. This is true for any website you visit.

Latest revision as of 04:46, 9 March 2024

Introduction

Buoy is an all-in-one data-logging and tuning tool for the SSSICK (SSSQUID INPUT CONVERSION KIT).

From Buoy you can monitor live data (airflow rate and intake air temperature), log these parameters to a file, and tune the SSSICK for different input and output sensors.

Expect new software to be released regularly. You can check for and download any updates from within Buoy, or by checking this page and downloading it directly.

This tool was developed in and for Linux first, however Windows versions are available as well. We have no plans to develop an OSX version.

An Android version will shortly be available for the Bluetooth-enabled hardware (revisions R019 and newer). We have no plans to develop an iOS app.

Please contact us with any bugs you may encounter.


Download

The software is updated regularly. You can generally expect at least a few updates per month as we add more features and make more improvements. Please make sure to click "Check for updates" in the menu bar occasionally to stay updated!

Latest Release

This software version represents a rather large change to how most things work within Buoy in comparison with the last public release (0.20). It is compatible with all hardware R015 and newer. We will be adding further backwards compatibility in the future!

Version: 0.21.1203 (Released: 2024.04.08)


If you have a system that is NOT based on AMD/Intel 64-bit processors, we can compile the application to work with other architectures (such as ARM). Since this is so rare, we don't compile every single version for these particular systems. Please contact us for downloads! However, for the 99% of you who are using Intel- or AMD-based 64-bit processors, the above downloads will work perfect!

For users that want to flash updated firmware to their kit: please consult the FLASHING page

View the 0.21 changelog

Previous version (0.20)

We offer a previous version of the software for those that prefer the multi-window UI. We may continue to add support for the latest hardware and firmware versions, thought it won't be updated as often as the latest version of Buoy.

Current Version: 0.20.0507 (Released: 2023/04/25)

  • LINUX 64-bit
  • WINDOWS 64-bit

Previous Version: 0.20.0506 (Released: 2023/03/14)

If you have a system that is NOT based on AMD/Intel 64-bit processors, we can compile the application to work with other architectures (such as ARM). Since this is so rare, we don't compile every single version for these particular systems. Please contact us for downloads! However, for the 99% of you who are using Intel- or AMD-based 64-bit processors, the above downloads will work perfect!

View the 0.20 changelog

Older version (0.18)

This version works exclusively with hardware versions R003 through R018. It will not work with anything newer, or any versions using any firmware past 0182099.

Latest Stable Version: 0.18.09 (Released: 2021/11/05)

"JRE pre-compiled" vs "JRE required": JRE stands for Java Runtime Environment. It is what allows you to run Java applications. This is an extremely common thing to have installed. Many applications that require it will install it for you, or may point you to the right download page to install it yourself. Similarly, many operating systems (mostly the major Linux flavors) will come with JRE pre-installed.

We offer two versions for download, JRE required and JRE pre-compiled. "JRE required" offer a vastly smaller download size for people who already have the JRE installed. "JRE pre-compiled" will download Buoy with JRE included within the application itself, but will therefore be a much larger file (about 200 MB compared to the much smaller 40 MB "JRE required" download).

If you are unsure what JRE is, if you have it, or what you should do -- the best idea would be to download the JRE pre-compiled version and not worry about it.

Previous versions available by request, though you should most likely be using the latest version!

SSSICK firmware versions before R01807 may not plot data at the correct rate for the Buoy software versions 0.18.07 and newer, please contact us for the latest firmware!

Hardware R011 and Older

Due to the complications of command-line interaction with the older units, we've taken down a lot of the instructions. However, we are happy to help anyone that needs help with their R011 or older hardware, just email us! [email protected]

We can provide the latest firmware rewritten for the older hardware versions, which will make it compatible with the latest versions of Buoy.

Archive

While we do recommend using the latest software, previous versions of each major release are available in our archives:

Version Archive


Installation

This program is designed to be portable -- there is no installation necessary.

All you will have to do is extract the files from the .zip (Windows) or .tar.gz (Linux) file to their own directory, then double-click "Buoy.exe" for Windows, or for Linux "Buoy.sh".

For some Linux distributions, you may have to right-click and select "Run as a Program":

Run as program.png

Linux users, if your Buoy.sh file will not run, you may need to set the correct executable permissions for the file. This can be done by opening a terminal window, navigating to the folder that contains "Buoy.sh", and running the following command:

chmod +x Buoy.sh

Now try running Buoy.sh again. Simple as that!

Drivers

All drivers are now pre-packaged. There should not be any need to install additional drivers.

You only need drivers when flashing using the USB dongle in older versions. You can get these drivers and read more about flashing on the Flashing page HERE.

Usage

Software 0.21

Software 0.20

Older software:

Software 0.19

Software 0.18

Firmware

As of firmware 0190923 and newer, flashing to a new MAF/MAP/TPS/VAM can be done independently and wirelessly through Buoy and without the need to flash the unit with the hardware flashing module. Newer hardware versions do not include a firmware flashing dongle as it's no longer necessary. We are happy to flash your SSSICK to the latest firmware at NO COST, please contact us to get setup!

For older hardware we wanted to include the ability to update the firmware as it was continually developed in order to support new features. Therefore a flashing dongle was included. While it's not necessary to run the latest firmware, you may notice improvements by using it. If you'd like a copy of the latest firmware, please email us with your order number or hardware version and we'll get you setup as soon as possible. If you are on older hardware (specifically R018 or older) then updating the latest FW is highly recommended and it will allow you to tune within Buoy. Please contact us for downloads [email protected]!

".MCKF" files contain the firmware for your specific hardware version. Since we are constantly releasing new versions, please contact us with your required MAF and VAM combination and your hardware version, we will reply with a download of the latest available software.

All units ship with the proper and latest available firmware for your hardware and are pre-programmed for your selected MAF and VAM, so there is no need to flash a new unit unless you need the newest features, there are fixes, or the latest Buoy software requires it.

As of September 13th, 2022 a new firmware version is available with vastly improved filtering and overall operation. We have produced retro firmware for hardware R013 through R019. All hardware versions R020 already contain the latest firmware. If you have older hardware and want the latest features, please contact us for firmware downloads!

FLASHING INSTRUCTIONS

Tuning

Read more on the Tuning page!

Connection

You can find tutorials on how to connect and troubleshoot connections on various operating systems here: SSSICK/BUOY/Connection

Data Collection Policy

At no point does Buoy collect any user data. No data is collected, recorded, or sent to us in any fashion. The only time Buoy ever contacts our servers is when you manually click the "Check for update" button, or you download an update. No personalized or identifiable data is collected in doing this, but your public IP is logged because it's a necessary process in order to actually make contact with our servers. This is true for any website you visit.

Retrieved from "https://wiki.sssquid.com/index.php?title=SSSICK/BUOY&oldid=1537"