Add calibration example #76

sterlinghirsh · 2021-01-19T02:17:36Z

This changes the structure of drawing shapes a bit so that instead of just receiving a resolution, Shape.draw() accepts a SceneOptions object, which contains resolution, fps, blankingPoints, maxWaitPoints. This replaces the constants RESOLUTION, BLANKING_AMOUNT, and MAX_WAIT_AMOUNT and lets us update the values without restarting the program.

This change adds a calibration interface (examples/calibration). This lets you update parameters like pps, resolution, blanking points, and max wait points in real time from a web UI. The UI also displays stats and performance output. For example:

{
  "devices": {
    "Simulator": {},
    "Helios": {
      "calculated": {
        "duration": 547.624,
        "successPps": 13412,
        "attemptedPps": 13428,
        "successPpsPercentOfNominal": 53.648,
        "attemptedPpsPercentOfNominal": 53.712,
        "avgFramePoints": 448,
        "avgFrameDisplayMs": 18,
        "avgFrameAllotmentUtilization": 53.78151260504202,
        "avgFrameDeviceLimitUtilization": 10.942843185148998,
        "notReadyFramePercent": 0
      },
      "startTime": 1611021814277,
      "secondsPerPoint": 0.00004,
      "msPerPoint": 0.04,
      "microsecondsPerPoint": 40,
      "maxTheoreticalAccel": 1250,
      "fixedFrameRate": {
        "fps": 30,
        "allottedFrameMs": 33,
        "allottedFramePoints": 833,
        "frameAllotmentPercentOfDeviceLimit": 20.34684904738642
      },
      "points": {
        "Success": 7344513,
        "Not Ready": 0,
        "Fail": 9205,
        "Empty": 0
      },
      "frames": {
        "Success": 16398,
        "Not Ready": 0,
        "Fail": 20,
        "Empty": 0
      },
      "lastFrame": {
        "points": 433,
        "result": "Success",
        "drawMs": 17.32,
        "maxJumpX": 0.75,
        "maxJumpY": 0.5,
        "maxJump": 0.75,
        "maxSpeed": 18750,
        "maxAccel": 468.75
      },
      "allFrames": {
        "maxJumpX": 0.75,
        "maxJumpY": 0.5,
        "maxJump": 0.75,
        "maxSpeed": 18750,
        "maxAccel": 468.75
      }
    }
  }
}

Further work:

Build a nicer react-based UI
Persist the calibration settings
Allow setting dwell and blanking by time instead of by points

My laser (via helios) would stay on when I'd shut down the program, so I added a shutdown handler for safety and convenience. I didn't add it for any other devices since I don't have any to test, but it should be a simple change to add it.

Add Shutdown Handler

This lets us load the package for unsupported devices without crashing. There are probably more incompatibilities, but the windows DACs were the ones causing a problem for me.

There's some other problems with this example but those changes will come later.

Add device selector

This was causing a typescript issue for me because ilda-reader and draw both use a Point interface. They're different but they both overlap on r, g, and b, which is all we care about.

Clamp points

It was off by one, so you could get an out-of-bounds value. This immediately fixed at least one example that draws a bounding box.

This was flipping both X and Y, but only Y needed to be flipped. This became apparent when using the svg-path example when the text was backwards.

Fix helios resolution

This makes the animation a bit less jerky by using the actual time since the last frame to determine movement.

They're called balls, might as well use a Circle.

Improve balls

Add transformer to convert all points to monochrome

It's a bit simpler since these functions are just mapping a function on points.

Add makeTransformer() and use with clamp and monochrome

It's a little more clear that it will take a Point from core and turn it into a helios point.

I'm not able to achieve the expected pps on my device. I think it's because writing in small chunks has more overhead.

Helios rework drawing

Nothing has changed yet, but this will make the diff easier to read

Get rid of the old stuff and and add the new stuff. It will talk to a webpage with a websocket and change settings in real time.

Just works on helios for now.

This lets us show stats and sync settings both ways.

It's a bit redundant since we're displaying them through the web UI

This is stuff like max speed and acceleration for each frame for all time.

It wasn't that useful to have stats assume we're starting from the middle since it would always cause a big acceleration spike at the start.

This will let us pass more parameters to shapes as we draw.

This allows blankingAmount and maxWaitAmount to be changed.

sterlinghirsh · 2021-01-19T02:19:53Z

I realize this is a big change, since I think this is the full diff from my fork. Feel free to leave feedback if you feel like it, though I understand if you don't have time to work on this project for now.

sterlinghirsh added 30 commits October 25, 2020 13:50

Add Shutdown Handler

03b6ad7

My laser (via helios) would stay on when I'd shut down the program, so I added a shutdown handler for safety and convenience. I didn't add it for any other devices since I don't have any to test, but it should be a simple change to add it.

Merge pull request #1 from sterlinghirsh/add-shutdown-handler

a9f3d24

Add Shutdown Handler

Add isSupported() to Device class

93b74f1

This lets us load the package for unsupported devices without crashing. There are probably more incompatibilities, but the windows DACs were the ones causing a problem for me.

Add device-selector: auto-select a DAC + Simulator

0d3c3d9

Use device-selector instead of hard-coding devices

1908354

Balls: update example for device-selector

bbce90f

There's some other problems with this example but those changes will come later.

Use device-selector in remaining examples

5a82d8f

Merge pull request #2 from sterlinghirsh/add-device-selector

db9aee5

Add device selector

Ilda: clarify types around Point

2928d17

This was causing a typescript issue for me because ilda-reader and draw both use a Point interface. They're different but they both overlap on r, g, and b, which is all we care about.

Clamp points as final step in Scene

8a7b840

Merge pull request #3 from sterlinghirsh/clamp-points

85fc85b

Clamp points

Helios: fix resolution

b3b1535

It was off by one, so you could get an out-of-bounds value. This immediately fixed at least one example that draws a bounding box.

Helios: flip Y but not X

e2ab78a

This was flipping both X and Y, but only Y needed to be flipped. This became apparent when using the svg-path example when the text was backwards.

Merge pull request #4 from sterlinghirsh/fix-helios-resolution

3680e63

Fix helios resolution

Balls: bounce off the walls properly

6744dbe

Balls: Make animation time-based

682191d

This makes the animation a bit less jerky by using the actual time since the last frame to determine movement.

Balls: use Circles instead of Rects

8bcc2b1

They're called balls, might as well use a Circle.

Merge pull request #5 from sterlinghirsh/improve-balls

d8d1ed9

Improve balls

Add transformer to convert all points to monochrome

5f591a7

Merge pull request #6 from sterlinghirsh/monochrome

7fb1a14

Add transformer to convert all points to monochrome

Add makeTransformer() and use with clamp and monochrome

0bfb012

It's a bit simpler since these functions are just mapping a function on points.

Merge pull request #7 from sterlinghirsh/clamp--make-transformer

248dd65

Add makeTransformer() and use with clamp and monochrome

Helios: fix convertPoint declaration

b9ed76b

It's a little more clear that it will take a Point from core and turn it into a helios point.

Helios: extract sendFrame function from stream

9accea2

Helios: start tracking stats

4f2187d

Track some more stats

eef5a13

I'm not able to achieve the expected pps on my device. I think it's because writing in small chunks has more overhead.

Helios: add FrameMode enum

b49c98a

Helios: use variable for dacNum

83a87cb

Merge pull request #8 from sterlinghirsh/helios-rework-drawing

b3e9b87

Helios rework drawing

Copy square interactive example to calibration

3af2928

Nothing has changed yet, but this will make the diff easier to read

sterlinghirsh added 16 commits November 27, 2020 19:31

Calibration: start modifying example

2f055d8

Get rid of the old stuff and and add the new stuff. It will talk to a webpage with a websocket and change settings in real time.

Calibration: update dac pointsrate in real time

35427cd

Just works on helios for now.

Calibration: add two-way communication

e20649a

This lets us show stats and sync settings both ways.

Helios: replace stats.pps with pointsRate

d16ecb7

Helios: Rework more stats

e4475b9

Helios: Drop printStats()

adb98b7

It's a bit redundant since we're displaying them through the web UI

Calibration: make getStats() always return an Object for simplicity

aed38f7

Calibration: start recording stats about frame content

0420a09

This is stuff like max speed and acceleration for each frame for all time.

Calibration: omit initial jump from stats

da0ed6f

It wasn't that useful to have stats assume we're starting from the middle since it would always cause a big acceleration spike at the start.

Calibration: live-update resolution

02a1261

Drop unused RESOLUTION constant.

9956f8e

Helios: Track stats no longer has ts undefined warning

2d7faa3

Scene: store options in object

a9c543f

Shape: draw() accepts SceneOptions instead of resolution

71c59a8

This will let us pass more parameters to shapes as we draw.

Replace values from constants.ts with SceneOptions

80d940b

This allows blankingAmount and maxWaitAmount to be changed.

Calibrate: allow changing blankingPoints and maxWaitPoints

66e4ec8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add calibration example #76

Add calibration example #76

Uh oh!

sterlinghirsh commented Jan 19, 2021

Uh oh!

sterlinghirsh commented Jan 19, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Add calibration example #76

Are you sure you want to change the base?

Add calibration example #76

Uh oh!

Conversation

sterlinghirsh commented Jan 19, 2021

Uh oh!

sterlinghirsh commented Jan 19, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant