chatbot enhancements

diylc/diylc-core/pom.xml

@@ -57,6 +57,11 @@
             <artifactId>reflections</artifactId>
             <version>0.10.2</version>
         </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>2.16.1</version>
+        </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>

diylc/diylc-core/src/main/java/org/diylc/common/INetlistAnalyzer.java

@@ -50,11 +50,10 @@ public interface INetlistAnalyzer {
    * Summarizes all {@link Netlist}s provided. 
    * 
    * @param netlists
-   * @param preferredOutput optional, needed only where there's more than one possible output node.
    * @return
    * @throws TreeException 
    */
-  List<Summary> summarize(List<Netlist> netlists, Node preferredOutput) throws TreeException;
+  List<Summary> summarize(List<Netlist> netlists) throws TreeException;
   
   /**   
    * @return name of the font to be used for display.

diylc/diylc-core/src/main/java/org/diylc/netlist/AbstractNetlistAnalyzer.java

@@ -30,10 +30,10 @@ public abstract class AbstractNetlistAnalyzer {
 
   public AbstractNetlistAnalyzer() {}
   
-  public List<Summary> summarize(List<Netlist> netlists, Node preferredOutput) throws TreeException {    
+  public List<Summary> summarize(List<Netlist> netlists) throws TreeException {
     Map<String, Summary> summaries = new HashMap<String, Summary>();
     for (Netlist n : netlists) {
-      Summary s = summarize(n, preferredOutput);
+      Summary s = summarize(n);
       if (summaries.containsKey(s.getSummary()))
         summaries.get(s.getSummary()).append(n);
       else
@@ -46,7 +46,7 @@ public abstract class AbstractNetlistAnalyzer {
     return res;
   }
   
-  protected abstract Summary summarize(Netlist netlist, Node preferredOutput) throws TreeException;
+  protected abstract Summary summarize(Netlist netlist) throws TreeException;
 
   public Tree constructTreeBetween(Netlist netlist, Node nodeA, Node nodeB) {
     Tree tree = new Tree(TreeConnectionType.Parallel);

diylc/diylc-core/src/main/java/org/diylc/plugins/chatbot/presenter/ChatbotPresenter.java

@@ -23,10 +23,19 @@ package org.diylc.plugins.chatbot.presenter;
 
 import com.diyfever.httpproxy.PhpFlatProxy;
 import com.diyfever.httpproxy.ProxyFactory;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
 import org.apache.log4j.Logger;
+import org.checkerframework.checker.units.qual.C;
 import org.checkerframework.checker.units.qual.N;
 import org.diylc.appframework.miscutils.ConfigurationManager;
+import org.diylc.common.ComponentType;
+import org.diylc.common.IPlugInPort;
 import org.diylc.common.PropertyWrapper;
+import org.diylc.core.IDIYComponent;
+import org.diylc.netlist.Group;
+import org.diylc.netlist.Netlist;
+import org.diylc.netlist.NetlistException;
 import org.diylc.plugins.chatbot.model.IChatbotAPI;
 import org.diylc.plugins.cloud.model.CommentEntity;
 import org.diylc.plugins.cloud.model.IServiceAPI;
@@ -38,16 +47,22 @@ import org.diylc.plugins.cloud.presenter.NotLoggedInException;
 import org.diylc.presenter.ComparatorFactory;
 import org.diylc.presenter.ComponentProcessor;
 
+import javax.swing.*;
+import java.awt.*;
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
+import java.lang.reflect.InvocationTargetException;
 import java.net.InetAddress;
 import java.net.NetworkInterface;
 import java.net.URL;
 import java.nio.channels.Channels;
 import java.nio.channels.ReadableByteChannel;
-import java.util.Collections;
+import java.util.*;
 import java.util.List;
+import java.util.stream.Collectors;
+
+import static org.diylc.utils.FileUtils.extractFileName;
 
 /**
  * Contains all the back-end logic for using the cloud and manipulating projects on the cloud.
@@ -56,17 +71,19 @@ import java.util.List;
  */
 public class ChatbotPresenter {
 
-  public static final ChatbotPresenter Instance = new ChatbotPresenter();
-
   private static String ERROR = "Error";
 
   private final static Logger LOG = Logger.getLogger(ChatbotPresenter.class);
   private static final Object SUCCESS = "Success";
+  private final IPlugInPort plugInPort;
+  private static final ObjectMapper MAPPER = new ObjectMapper();
 
   private IChatbotAPI service;
   private String serviceUrl;
 
-  private ChatbotPresenter() {}
+  public ChatbotPresenter(IPlugInPort plugInPort) {
+    this.plugInPort = plugInPort;
+  }
 
   private IChatbotAPI getService() {
     if (service == null) {
@@ -78,10 +95,193 @@ public class ChatbotPresenter {
     return service;
   }
 
-  public String promptChatbot(String project, String netlist, String prompt) throws NotLoggedInException {
+  public String promptChatbot(String prompt) throws NotLoggedInException {
     if (!CloudPresenter.Instance.isLoggedIn())
       throw new NotLoggedInException();
-    return getService().promptChatbot(CloudPresenter.Instance.getCurrentUsername(), CloudPresenter.Instance.getCurrentToken(),
-        CloudPresenter.Instance.getMachineId(), project, netlist, prompt);
+
+    String currentFile = plugInPort.getCurrentFileName();
+    String fileName = extractFileName(currentFile);
+
+    String netlist;
+    try {
+      netlist = extractNetlists();
+    } catch (NetlistException e) {
+      LOG.error("Error extracting netlist", e);
+      netlist = null;
+    }
+
+    return getService().promptChatbot(CloudPresenter.Instance.getCurrentUsername(),
+        CloudPresenter.Instance.getCurrentToken(),
+        CloudPresenter.Instance.getMachineId(), fileName, netlist, prompt);
   }
+
+  private static final Set<Class<?>> PROPERTY_TYPES_TO_SKIP = Set.of(Font.class, Color.class);
+
+  private String extractNetlists() throws NetlistException {
+    List<Netlist> netlists = plugInPort.extractNetlists(true);
+
+    StringBuilder sb = new StringBuilder();
+    sb.append("Components: ");
+
+    Set<? extends IDIYComponent<?>> components = netlists.stream().flatMap(n -> n.getGroups().stream()
+            .flatMap(g -> g.getNodes().stream().map(node -> node.getComponent())))
+        .collect(Collectors.toSet());
+
+    List<Map<String, Object>> componentDescriptors = new ArrayList<>();
+    
+    components.forEach(c -> {
+      ComponentType componentType = ComponentProcessor.getInstance()
+          .extractComponentTypeFrom((Class<? extends IDIYComponent<?>>) c.getClass());
+      List<PropertyWrapper> properties =
+          ComponentProcessor.getInstance().extractProperties(c.getClass());
+
+      Map<String, Object> componentDescriptorMap = new HashMap<>();
+      componentDescriptorMap.put("name", c.getName());
+      componentDescriptorMap.put("type", componentType.getName());
+      componentDescriptorMap.put("category", componentType.getCategory());
+
+      properties.forEach(p -> {
+        if (PROPERTY_TYPES_TO_SKIP.contains(p.getType()))
+          return;
+
+        try {
+          p.readFrom(c);
+          if (p.getValue() == null)
+            return;
+
+          componentDescriptorMap.put(p.getName(), p.getValue().toString());
+        } catch (Exception e) {
+          LOG.warn("Error extracting properties", e);
+        }
+      });
+      
+      componentDescriptors.add(componentDescriptorMap);
+    });
+
+    try {
+      String json = MAPPER.writeValueAsString(componentDescriptors);
+      sb.append(json).append("\n\n");
+    } catch (Exception e) {
+      LOG.error("Failed to serialize component descriptors to JSON", e);
+    }
+
+    for (Netlist netlist : netlists) {
+      sb.append("Switch configuration: ").append(netlist.getSwitchSetup()).append("\n\n")
+          .append("Connected node groups:\n\n");
+      for (Group v : netlist.getSortedGroups()) {
+        sb.append(v.getSortedNodes()).append("\n");
+      }
+    }
+    return sb.toString();
+  }
+
+  public String getInitialChatContents() {
+    Random r = new Random();
+
+    String chatHtml =
+        "<div class='system'>Welcome to the DIYLC AI Assistant!</div><br><br>\n" +
+            "<div class='assistant'>I'm here to help you design, build, and troubleshoot your electronics projects using DIY Layout Creator (DIYLC). You can ask me questions about:</div><br>\n" +
+            //            "<ul>\n" +
+            "\n" +
+            "- <b>Electronics theory or concepts:</b> <i>e.g.,</i> '<span class='user'>" + electronicsQuestions[r.nextInt(
+            electronicsQuestions.length)] + "</span>'<br>\n" +
+            "- <b>DIYLC features and usage:</b> <i>e.g.,</i> '<span class='user'>" + diylcQuestions[r.nextInt(diylcQuestions.length)] + "</span>'<br>\n" +
+            "- <b>Your current circuit project:</b> <i>e.g.,</i> '<span class='user'>" + circuitQuestions[r.nextInt(circuitQuestions.length)] + "</span>'<br>\n" +
+            //            "</ul><br>\n" +
+            "<br>\n" +
+            "<div class='assistant'>Feel free to ask your own question or use one of these examples to get started!</div><br>\n";
+
+    if (!CloudPresenter.Instance.isLoggedIn()) {
+      chatHtml = chatHtml + "<div class='system' id='login'>Please log into your DIYLC Cloud account in order to use the AI Assistant.</div><br>\n";
+    }
+
+    return chatHtml;
+  }
+
+  public static final String ASSISTANT = "assistant";
+  public static final String SYSTEM = "system";
+  public static final String USER = "user";
+  public static final String TEMPORARY = "temporary";
+
+  String[] electronicsQuestions = {
+      "What is Ohm's Law, and how do voltage, current, and resistance relate to each other?",
+      "Why are resistors important in circuits, and what happens if the resistor value is incorrect?",
+      "What is a capacitor, and how does it behave differently from a resistor?",
+      "How does an inductor work, and where might you find one in common DIY projects?",
+      "What's the difference between AC (Alternating Current) and DC (Direct Current), and where is each used?",
+      "How do diodes work, and why are they essential in electronics?",
+      "What's the difference between series and parallel circuits, and why does it matter?",
+      "How does a transistor function, and what role does it typically play in a circuit?",
+      "Why is grounding important in electronic circuits, and what exactly does it do?",
+      "What is impedance, and why is it important when connecting speakers or audio equipment?",
+      "What exactly is an operational amplifier (op amp), and what are its common uses in audio circuits?",
+      "How does a relay work, and when would you choose a relay over a transistor or MOSFET?",
+      "What's the purpose of using a fuse or circuit breaker in a DIY electronics project?",
+      "Why do certain electronic components need specific voltage ratings?",
+      "What is electromagnetic interference (EMI), and how can you minimize it in your projects?",
+      "What does polarity mean for components like electrolytic capacitors and diodes, and why is it important?",
+      "How does filtering work to remove unwanted noise from audio signals or power supplies?",
+      "What is signal clipping in audio circuits, and how can you prevent it?",
+      "Why do some circuits require a heatsink, and how do heatsinks help protect components?",
+      "What is frequency response, and why is it crucial for audio circuits like guitar pedals and amplifiers?",
+      "How do you calculate the correct resistor value for limiting current to an LED?",
+      "What is the role of a voltage regulator, and how does it keep voltage stable?",
+      "How can you measure and verify voltage and current safely using a multimeter?",
+      "What does it mean when a circuit is described as having a 'high input impedance' or 'low output impedance,' and why does it matter?",
+      "How can you determine if components in your circuit are properly rated for the voltage and current they're experiencing?"
+  };
+
+  String[] diylcQuestions = {
+      "How do I add a component to my layout in DIYLC?",
+      "How can I quickly find a specific component in DIYLC?s component toolbox?",
+      "How do I move or reposition components on the canvas in DIYLC?",
+      "How do I edit or change a component?s properties (e.g. value or color) in DIYLC?",
+      "Is there a shortcut to duplicate or repeat the last component I placed in DIYLC?",
+      "How can I group multiple components so I can move or edit them together in DIYLC?",
+      "What are ?building blocks? in DIYLC and how do I create or use them?",
+      "How do I save my DIYLC project and reopen it later on?",
+      "How do I export my DIYLC layout as an image or PDF file?",
+      "Can DIYLC generate a bill of materials (BOM) for my project, and how would I do that?",
+      "How can I change or hide different layers in a DIYLC project to manage overlapping components?",
+      "Is it possible to view the underside of a board in DIYLC, and how can I enable that?",
+      "What does the ?Highlight Connected Areas? feature do in DIYLC and how do I use it for debugging?",
+      "How can I analyze a guitar wiring diagram using DIYLC?s built-in tools?",
+      "How do I assign a custom keyboard shortcut to a component in DIYLC for quick access?",
+      "What are component variants in DIYLC and how can I create and apply them?",
+      "What is the continuous creation mode in DIYLC and how does it help when adding many components?",
+      "How can I create a custom component to add to DIYLC?s component library?",
+      "Does DIYLC support plug-ins, and how can I add new functionality to the app with them?",
+      "What is the DIYLC cloud feature and how can I share or download projects using it?"
+  };
+
+  String[] circuitQuestions = {
+      "What's the purpose of this specific resistor in my circuit?",
+      "How do I correctly determine capacitor values for my power supply?",
+      "How should I route wiring to reduce interference and noise?",
+      "Which component should I choose for this switching application, a MOSFET or BJT?",
+      "How do I verify if my ground connections are optimal?",
+      "Why might this transistor get hot during operation?",
+      "What's the best approach to simplify this section of my circuit?",
+      "How can I ensure my circuit is safe against short circuits?",
+      "What could be causing voltage instability in this circuit?",
+      "How do I properly size resistors to protect LEDs?",
+      "What are the steps to debug unexpected oscillations in my circuit?",
+      "Should I add a bypass capacitor here, and what value should I use?",
+      "How can I check if my components are operating within their rated specifications?",
+      "Is this the right way to connect multiple power rails in my design?",
+      "How can I test my circuit before physically assembling it?",
+      "What are good layout practices to minimize electromagnetic interference?",
+      "How do I identify if my circuit has any redundant or unnecessary components?",
+      "Why might the voltage regulator not output the expected voltage?",
+      "What's the recommended method for isolating digital and analog grounds?",
+      "How do I safely integrate high-voltage components into my DIY circuit?",
+      "Why isn't my LED lighting up when powered?",
+      "How do I troubleshoot a circuit that's drawing more current than expected?",
+      "Why does my amplifier circuit produce a humming or buzzing sound?",
+      "How can I detect and fix intermittent connections in my circuit?",
+      "What should I check if my circuit isn't responding to input signals as expected?",
+      "How do I determine if my soldering joints are causing reliability issues?",
+      "What steps can I take if my microcontroller circuit isn't functioning as intended?",
+      "How do I troubleshoot a noisy or unstable sensor reading?"
+  };
 }

diylc/diylc-core/src/main/java/org/diylc/utils/FileUtils.java

@@ -0,0 +1,24 @@
+package org.diylc.utils;
+
+import java.io.File;
+
+public class FileUtils {
+
+  /**
+   * Extracts the base file name without extension from a full path.
+   * For example: "/path/to/myfile.diy" returns "myfile"
+   */
+  public static String extractFileName(String path) {
+    if (path == null || path.isEmpty()) {
+      return "Untitled";
+    }
+    // Get the last part after the last separator
+    String fileName = path.substring(path.lastIndexOf(File.separator) + 1);
+    // Remove the extension if present
+    int dotIndex = fileName.lastIndexOf('.');
+    if (dotIndex > 0) {
+      fileName = fileName.substring(0, dotIndex);
+    }
+    return fileName;
+  }
+}