SSSICK/BUOY: Difference between revisions

From WWWIKI
 
(236 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).


From Buoy you can monitor live data (airflow rate), log it to a file, replay old logs, update firmware, and program the SSSMCK for different MAF, MAP, or TPS sensors, and different vehicle's.
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.


This tool was developed in and for Linux first, however it's obvious that most users will have Windows, so development has shifted more toward that recently. At the moment the Linux flavors still run better. There is no version for Mac OSX and we do not have any plans to ever develop an app for it.
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.


Expect new software to be released regularly. We have not implemented an auto-update function yet. Please bookmark this page to get quick access to the latest software.
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 eventually be available for Bluetooth-enabled hardware (revisions R019 and newer). We have no plans to ever develop an iOS app because it's garbage.
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.


Starting with second-generation R019 hardware we are no longer including flashing hardware. The firmware is in its final, or near-final form, and should not require updating to get everything you need out of it. All customization features have been coded in, and the unit can be FULLY TUNED OVER BLUETOOTH. Using software version 0.19.12 and newer you can access and tune all of the features on your R019 hardware using FW versions 0191426 and newer (you can check your FW version from within Buoy, see below). We will also be releasing firmware for R018 hardware to gain access to the latest features. Please contact us for R018 firmware downloads.
If you purchased your R019 HW prior to May 2022 (known as first-generation R019), you will want to update to the latest  firmware (please contact us for the latest FW). There are VERY MINOR differences in circuit design and hardware between first- and second-gen R019 hardware, so the firmware is interchangeable. First-gen R019 hardware is versioned between R01901 through R01905; second-gen R019 hardware is versioned R01906 and higher.


=Download=
=Download=


All you will have to do is extract the "Buoy" folder from the .zip (Windows) or .tar (Linux) file and double-click "Buoy.exe" for Windows, or for Linux, double-click the "Buoy.sh" and select "run".
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!


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 code:
==Latest Release==


$ chmod +x Buoy.sh
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!


Now try running Buoy.sh again. Simple as that!
Version: 0.21.1203 (Released: 2024.04.08)


==Hardware R019 and Newer==
*'''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]


Hardware R019 contains major updates that require the newest firmware. The new firmware contains major updates that can only be taken advantage of using the newest PC software. While you can use Buoy 0.18.xx for the most basic logging functions, you will need to use Buoy 0.19.xx to take full advantage of all the new features.
*'''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]


In order to make sure of all the new features properly, the latest software contains MAJOR changes and is even written in a different top-level programming language.


Latest Stable Version: 0.19.1767 (Released 28 June 2022)
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!
* [https://sssquid.com/strg/sssmck/buoy/Buoy_0_19_1767_Windows.zip WINDOWS DOWNLOAD]
* [https://sssquid.com/strg/sssmck/buoy/Buoy_0_19_1767_Linux.tar LINUX DOWNLOAD]


==Hardware R013-R018==
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]


Latest Stable Version: 0.18.09 (Released 05 November 2021)
==Previous version (0.20)==
*Windows
**32-bit (JRE required) - [https://sssquid.com/strg/sssmck/buoy/buoy-01809-win32.zip Download]
**64-bit (recommended for most users! Pre-compiled JRE included) - [https://sssquid.com/strg/sssmck/buoy/buoy-01809-win64-wjre.zip Download]
**64-bit (JRE required) - [https://sssquid.com/strg/sssmck/buoy/buoy-01809-win64.zip Download]
*Linux
**32-bit - [https://sssquid.com/strg/sssmck/buoy/buoy-01809-lin32.tar Download]
**64-bit - [https://sssquid.com/strg/sssmck/buoy/buoy-01809-lin64.tar Download]


"JRE pre-compiled" vs "JRE required":
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.
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 370 MB versus the much smaller 40 MB "JRE required" download).
Current Version: 0.20.0507 (Released: 2023/04/25)


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.  
* 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]


Previous versions available by request, though you should most likely be using the latest version!
Previous Version: 0.20.0506 (Released: 2023/03/14)


SSSMCK 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!
* 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]  


==Hardware R011 and Older==
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!


Due to the complications of commandline 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
[https://content.sssquid.com/sssmck/buoy/changelog.html View the 0.20 changelog]


=Installation=
==Older version (0.18)==
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).
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.


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 a 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.
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]


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 system's package manager.
"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.


==Drivers==
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).
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]
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.  


=Interface=
Previous versions available by request, though you should most likely be using the latest version!
*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=
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!


==Hardware R011 and Older==


==Connecting==
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]
===R019===
Starting with R019 hardware the SSSMCK is not bluetooth enabled. While it no longer offers the option for flashing firmware by the user, it can be fully tuned wirelessly without the need to open it or plug it in to a USB cable. If you have an older unit or firmware, we are happy to reflash any unit to the latest firmware at no charge, please email us to get setup!


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


From the Bluetooth main menu, select "Add Bluetooth or other device"
==Archive==
While we do recommend using the latest software, previous versions of each major release are available in our archives:


[[File:Bluetooth main menu.png]]
[[SSSICK/BUOY/ARCHIVE|Version Archive]]


It will ask you to select "Bluetooth device", at which point your computer will scan for the SSSMCK.


Click on "SSSMCK" and it will prompt you for a password. Enter "1234" and click "Connect".
=Installation=
This program is designed to be portable -- there is no installation necessary.


[[File:Add sssmck.png]]
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".


=====Troubleshooting=====
For some Linux distributions, you may have to right-click and select "Run as a Program":
Sometimes Windows 10 will not automatically allocate a COM port for Bluetooth devices. You can fix this by following these instructions:


*Open Windows main settings by opening the "Start" menu and clicking on the "Settings" icon or by typing "Settings" and opening the "Settings" app.
[[File:Run as program.png]]
*Select "Devices" from the main menu presented. [[File:Main_settings_devices.png|center]]
*Under "Related Settings", which you can find either on the right-side or by scrolling down, click on "Devices and printers". [[File:Bluetooth_and_other_devices.png|center]]
*Find "SSSMCK" under the "Unspecified" section. Right-click it and select "Properties". [[File:Devices_and_printers_bt.png|center]]
*A new window will pop-up. Select the tab titled "Services". Then make sure the box is checked that says "Serial port (SPP)". [[File:Sssmck_properties_serial_port_bt.png|center]]
*Select "OK". The SSSMCK will now be able to communicate normally! After you complete this task, you can find the COM port # by returning to the "Services" tab of the "Properties" window. You can see in this screenshot that the SSSMCK is bound to COM port 4 (COM4): [[File:Sssmck_properties_serial_port.png|center]]


====USB====
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:


With R019, the connection is now 100% wireless. Please see the bluetooth setup section for more information.
<code>chmod +x Buoy.sh</code>


===R014-R018===
Now try running Buoy.sh again. Simple as that!
With the top cover removed, you will need to find a 6-pin header. This is where the logging/flashing module will be plugged.


[[File:Loggingmoduleport.jpg|center|thumbnail]]
==Drivers==


Plug in your logging/flashing module. It can only be inserted in one direction.
All drivers are now pre-packaged. There should not be any need to install additional drivers.


[[File:Loggingmoduleconnected.jpg|center|thumbnail]]
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]].


Connect the USB cable to your computer. If you are logging, please skip the next step.
=Usage=


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/BUOY/Usage/SW0_21|Software 0.21]]


[[File:Usbpowerselected.jpg|center|thumbnail]]
[[SSSICK/BUOY/Usage/SW0_20|Software 0.20]]


Once you finish flashing, please make sure to move this jumper back to the "REG" side before continuing use on your vehicle.
Older software:


===Software===
[[SSSICK/BUOY/Usage/SW0_19|Software 0.19]]
On the "Main" tab you will find the connection and flashing options.


[[File:Buoy_main_disconnected.png|center|thumbnail|600px]]
[[SSSICK/BUOY/Usage/SW0_18|Software 0.18]]


First you will need to select the correct port. Click on "Select Port" and you will be presented with a list of available ports.
=Firmware=


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.
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!


[[File:Buoy_main_selectport.png|center|thumbnail|600px]]
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]!


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.
".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.
 
[[File:Buoy_main_connected.png|center|thumbnail|600px]]
 
==Data-logging==
Once connected the SSSMCK should automatically begin transmitting airflow data to the program. This is displayed in kilograms per hour (Kg/Hr).


[[File:Buoy_livedash_logging.png|thumbnail|center|600px]]
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.


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).
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!


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.
[[SSSICK/BUOY/FLASHING|FLASHING INSTRUCTIONS]]


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.
===Log Replay===
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.
[[File:Buoy_logreplay.png|thumbnail|center|600px]]
You can manipulate the data, apply filters, change how it is displayed, and more by using the "Graph Options" and "Data Manipulation" sections.
==Flashing==
In hardware version R019xx and newer, flashing is no longer necessary to change various settings. Instead you can program your unit for various sensors and adjust various tuning parameters through Buoy and without the need for a hardware flashing module.
If you are using R018 and older, please follow the below instructions:
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.
[[File:Buoy_main_flash.png|center|thumbnail|600px]]
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.
==Configuration==
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.
It's recommended to leave the connection settings alone, they should be configured correctly by default. The interface scaling and themes are easily configurable here.
=Firmware=
".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 are changing vehicles/tunes/MAFs, there are fixes, or the latest software requires it.
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.
=Tuning=
=Tuning=
Tuning from within Buoy is currently in alpha-stages, it will be available publicly soon!
Read more on the [[SSSICK/BUOY/Tuning|Tuning page]]!
==Parameters==
=Connection=
===Input Sensor===
There are many different input sensors to choose from: Mass AirFlow sensors, Throttle Position sensors, and Manifold Air Pressure sensors. While each unit is shipped pre-programmed for the sensor you chose at checkout, you can always reprogram it for a new sensor later.
 
You can use one of the available MAF sensors freely without the need for a specific ECU tune. However some sensors, such as  TPS and MAP, require you to have a specific ECU tune in order to run properly.
 
===Output VAM===
This is the sensor that your ECU is tuned for. This is almost certainly the stock VAM that your vehicle was equipped with, unless it was changed and your ECU was retuned for another sensor at some point.
 
===Averaging===
Enable to allow the SSSMCK to perform software averaging of signal processing. This is enabled by default.
 
We recommend a setting of somewhere between 20 and 40. A larger value means slower reaction, but perhaps smoother operation. A smaller value means sharper response, but an overly small value will provide the ECU with too much noise and may cause rocky operation.
 
*Recommended values based on input sensor used:
**MAF: 20-40
**TPS: 5-15
**MAP: 25-50
 
===Manual Correction===
Enable this to allow the making of manual corrections to output. This scalar is part of a final output equation. Adjusting this directly affects the calculated airflow. (E.G. 100 kg/hr will be converted to 105 kg/hr with a correction scalar of 1.05)
 
===Dynamic Correction===
Leave this disabled unless you are having issues with fuel ratios that cannot be fixed with minor manual corrections.
 
Enable this to allow the SSSMCK to automatically make corrections to output based on discrepancies. This scalar cannot be set manually as it is dynamic and the SSSMCK will automatically learn different values for different airflow ranges.
 
This scalar directly affects output signal directly and not airflow values. This is used to adjust for voltage inputs that are slightly out of spec.
 
*Correction Limits
**The MINIMUM and MAXIMUM scalar values for how far the SSSMCK can go to make automatic adjustments.
**We recommend setting these limits to no less than 0.90 and no more than 1.10.
 
===Custom LED Color===
With our newer firmwares the LED operation has changed. You can now set your own custom LED color for normal operation. The default normal operation LED color is green. Resetting the unit to default values will also reset your custom LED color to  green.
 
This is expressed as an 8-bit integer value (between 0 and 255). A higher integer means a higher saturation of that color. Setting red, green, and blue to 255 will produce a white light. Setting all to 0 will produce no light. Setting red to 255, green to 0, and blue to 255 will produce a purple light.
 
===Timer Periods===
 
Adjust these to change how often the SSSMCK will perform certain activies and checks.
====Timer Period 1====
Timer Period 1 handles functions such as dynamic correction updates and manual correction updates. Lowering this will increase how often these corrections are made and updated. Raising this will slow down corrections.
 
Recommended values are between 40 and 60.
 
====Timer Period 2====
Timer Period 2 handles functions such as error checking. Lowering this will increase how often error checks are made. Raising this will slow down error checking. Recommended values are between 80 and 180.


===M40/2 Mode===
You can find tutorials on how to connect and troubleshoot connections on various operating systems here: [[SSSICK/BUOY/Connection]]
The M40/2 VAM has three outputs, one for IAT and two for airflow. Therefore an additional wire is added to units destined for an M40 or M42 engine. M42 mode enables the output of all three of these signals to the ECU.
*Operation Mode
**Default: The standard operation mode, what most people will use.
**Sweep: Used if the "default" option is providing inconsistent results.
**Inverse: We've found that the E36 M42 models prefer this setting.
*Threshold kg/hr
**The airflow rate at which M42 mode is active, Typically this is set to around 10-30.
*Output rate
**A scalar for the additional output signal. This is used to adjust for any possible discrepancies.


==Reset to default values==
=Data Collection Policy=
If you ever have trouble, you can easily reset everything to default values from within Buoy. Instructions will be available with the release of the next version of Buoy.
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.