bitfocus / companion-module-equipson-lightshark

MIT License
1 stars 2 forks source link

Request for LightShark LS-Core #3

Open guitarmac1 opened 2 years ago

guitarmac1 commented 2 years ago

Hi There Companion Team,

Could I request an instance for the Light Shark LS Core? It would be so helpful and super amazing. Here is the link to the manual. https://cdn.shopify.com/s/files/1/1741/5055/files/lightshark-ls-core_manual_rev_a.pdf?1400167766965088173

Thank you in advance. Jamie

Screen Shot 2022-11-07 at 4 59 37 pm
josephdadams commented 1 year ago

I've marked this as missing documentation because I opened the link you provided and didn't see anything specific regarding external control. It was more just general "how to use the device" instructions. You'll need to provide the protocol information before this can progress any further.

ziginfo commented 1 year ago

Hello the full manual can be downloaded here : https://community.lightshark.es/c/support-documents/ls-1-lightshark-user-manual_en-v1_4 I have attached below the OSC-commands for LightShark notice that there must always be an argument with the OSC-command; and most of the time it requires "FLOAT(0)" for example "/LS/Go/PB/5) FLOAT(0)" or "/LS/DBO FLOAT(0)" or "/LS/Page/Up FLOAT(0)" etc etc ...

LightShark_OSC-1 LightShark_OSC-2 LightShark_OSC-3

ziginfo commented 1 year ago

there is already a LightShark module in the companion library https://github.com/bitfocus/companion-module-equipson-lightshark BUT the LightShark-Module does not work at all for LightShark Software Versions 1.4 and 1.5 (don't know how it is for older software versions!)!! most of the OSC-commands are NOT complete and missing arguments !! most of the listed OSC commands need an argument "FLOAT(0)" added to work; without this argument all these OSC-commands are just ignored by LightShark so (in the .js file), instead of : args = []; there should be : args = [{type: 'f', value: 0}]; and even the following is NOT working ! : args = [{type: 'f', value: 1}]; as it needs "FLOAT (0)" instead of "FLOAT (1)"

and in any way there are many errors in the (actual) modules QSC-command list

guitarmac1 commented 1 year ago

Hi @ziginfo and @josephdadams Thank you for the reply above. I have this working with the Executors and companion. However, I am unable to get feedback with "Sync Only Executors" within LightShark, there is an outgoing and incoming port number. Incoming 8000 and outgoing 9000. Could this be implemented if you have had any other experience with this could you please share? Thank you so much in advance. It is really much appreciated.

Screenshot 2023-09-16 at 2 25 26 pm Screenshot 2023-09-16 at 2 25 56 pm
ziginfo commented 1 year ago

Hello I did not verifie if the request "/LS/Sync/Executors" really works (I'll test it and will publish the result here...) but "/LS/Sync" does work definitely !! remember that as I stated above there must ALWAYS be an argument "FLOAT(0)" or "f 0" following the initial request to validate the request !! Note also that : the request "/LS/Sync" does feedback the state of the Executors (ON or OFF ! but NOT the name-labels !!)

guitarmac1 commented 1 year ago

Hi @ziginfo how did you go with the button feedbacks? I have also posted it here https://github.com/bitfocus/companion-module-requests/issues/1266 and have had @leonreucher take a look at this also.

ziginfo commented 1 year ago

Hello guitarmac1 are-you "Jamie McEwen” on the Lightshark-Blog ?

to answer to your questions : for Touch-OSC all works fine !! when sending the OSC-Command "/LS/Sync” with the argument Float(0) or "/LS/Sync/Executors” with the argument Float(0); the feedback concerning the state ON or OFF of every Executor-Button is than sent back to Touch-OSC (but neither color nor name informations are sent back) to receive the right button state the Receive-Port on Touch-OSC must be the same as the Send-Port in LightShark this works fine and I use it very often… I remember that there has been a couple of softwares in the past where there was a bug with that; but in the latest softwares it works fine… be aware of the following : OSC-Feedback can only be received by one “receptor”… so if only Touch-OSC is running it works; but if you booted Protocol or Companion-OSC with the same "receive port" before Touch-OSC, Touch-OSC do not receive OSC- messages anymore (= OSC-Port-Conflict)

now, being able to receive Feedback on Companion is another thing and might be a problem first of all the included “LightShark” plgin-module does not work at all, because it has so many errors in it (as I stated already on the Github-Blog the biggest error on nearly all the Command Lines in the JS-File is that the argument (FLOAT(0) is missing or that it is wrong (written FLOAT(1) instead of FLOAT(0)

as I don’t know how to compile a new JS-File… and so, I personally cannot do more and other as simply state the errors !! (cannot fix it myself because all JS-Files are directly compiled in to the Companion-App !!)

you said that you use Companion with the LightShark… and that it works for you... so, do you use a standard OSC-module/plugin ? or did you compile the App with a new JS-File ?

a generic OSC-plugin works fine for sending out OSC-commands to the LightShark but its unable to receive Feedback (make lit buttons etc)

friendly greetings @+... Ziggy

Le 23 sept. 2023 à 08:35, guitarmac1 @.***> a écrit :

Hi @ziginfo how did you go with the button feedbacks? I have also posted it here bitfocus/companion-module-requests#1266 and have had @leonreucher take a look at this also.

— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.

ziginfo commented 1 year ago

Hello as you can see in the attached files the two OSC-Feedback-Commands "/LS/Sync” and "/LS/Sync/Executors” work perfectly fine !! friendly greetings

LightShark-TouchOSC-Protokol.txt protokol-lightshark1

guitarmac1 commented 1 year ago

Hello guitarmac1 are-you "Jamie McEwen” on the Lightshark-Blog ? to answer to your questions : for Touch-OSC all works fine !! when sending the OSC-Command "/LS/Sync” with the argument Float(0) or "/LS/Sync/Executors” with the argument Float(0); the feedback concerning the state ON or OFF of every Executor-Button is than sent back to Touch-OSC (but neither color nor name informations are sent back) to receive the right button state the Receive-Port on Touch-OSC must be the same as the Send-Port in Touch-OSC this works fine and I use it very often… I remember that there has been a couple of softwares in the past where there was a bug with that; but in the latest softwares it works fine… be aware of the following : OSC-Feedback can only be received by one “receptor”… so if only Touch-OSC is running it works; but if you booted Protocol or Companion-OSC with the same "receive port" before Touch-OSC, Touch-OSC do not receive OSC- messages anymore (= OSC-Port-Conflict) now, being able to receive Feedback on Companion is another thing and might be a problem first of all the included “LightShark” plgin-module does not work at all, because it has so many errors in it (as I stated already on the Github-Blog the biggest error on nearly all the Command Lines in the JS-File is that the argument (FLOAT(0) is missing or that it is wrong (written FLOAT(1) instead of FLOAT(0) as I don’t know how to compile a new JS-File… and so, I personally cannot do more and other as simply state the errors !! (cannot fix it myself because all JS-Files are directly compiled in to the Companion-App !!) you said that you use Companion with the LightShark… and that it works for you... so, do you use a standard OSC-module/plugin ? or did you compile the App with a new JS-File ? a generic OSC-plugin works fine for sending out OSC-commands to the LightShark but its unable to receive Feedback (make lit buttons etc) friendly greetings @+... Ziggy Le 23 sept. 2023 à 08:35, guitarmac1 @.***> a écrit : Hi @ziginfo how did you go with the button feedbacks? I have also posted it here bitfocus/companion-module-requests#1266 and have had @leonreucher take a look at this also. — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.

Hey Ziggy yes it's me on both platforms, hahahaha. let me check out Touch OSC again. I may ask you a few more questions on thank one. Thank you for being awesome. Ill touch base with you and @leonreucher

ziginfo commented 1 year ago

Hello no problem for any question about LightShark or Touch-OSC; I am using both a lot and I am pretty “comfortable” on both… attention : in my last email there was an obvious error..!! I wrote :

to receive the right button state the Receive-Port on Touch-OSC must be the same as the Send-Port in Touch-OSC this works fine and I use it very often… but it should be : to receive the right button state, the Receive-Port on Touch-OSC must be the same as the Send-Port in LIGHTSHARK (!!) this works fine and I use it very often… sorry for this writing error

friendly greetings @+... Ziggy

Le 24 sept. 2023 à 12:50, guitarmac1 @.***> a écrit :

Hello guitarmac1 are-you "Jamie McEwen” on the Lightshark-Blog ? to answer to your questions : for Touch-OSC all works fine !! when sending the OSC-Command "/LS/Sync” with the argument Float(0) or "/LS/Sync/Executors” with the argument Float(0); the feedback concerning the state ON or OFF of every Executor-Button is than sent back to Touch-OSC (but neither color nor name informations are sent back) to receive the right button state the Receive-Port on Touch-OSC must be the same as the Send-Port in Touch-OSC this works fine and I use it very often… I remember that there has been a couple of softwares in the past where there was a bug with that; but in the latest softwares it works fine… be aware of the following : OSC-Feedback can only be received by one “receptor”… so if only Touch-OSC is running it works; but if you booted Protocol or Companion-OSC with the same "receive port" before Touch-OSC, Touch-OSC do not receive OSC- messages anymore (= OSC-Port-Conflict) now, being able to receive Feedback on Companion is another thing and might be a problem first of all the included “LightShark” plgin-module does not work at all, because it has so many errors in it (as I stated already on the Github-Blog the biggest error on nearly all the Command Lines in the JS-File is that the argument (FLOAT(0) is missing or that it is wrong (written FLOAT(1) instead of FLOAT(0) as I don’t know how to compile a new JS-File… and so, I personally cannot do more and other as simply state the errors !! (cannot fix it myself because all JS-Files are directly compiled in to the Companion-App !!) you said that you use Companion with the LightShark… and that it works for you... so, do you use a standard OSC-module/plugin ? or did you compile the App with a new JS-File ? a generic OSC-plugin works fine for sending out OSC-commands to the LightShark but its unable to receive Feedback (make lit buttons etc) friendly greetings @+... Ziggy … Le 23 sept. 2023 à 08:35, guitarmac1 @.***> a écrit : Hi @ziginfo how did you go with the button feedbacks? I have also posted it here bitfocus/companion-module-requests#1266 and have had @leonreucher take a look at this also. — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.

Hey Ziggy yes it's me on both platforms, hahahaha. let me check out Touch OSC again. I may ask you a few more questions on thank one. Thank you for being awesome. Ill touch base with you and @leonreucher

— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you were mentioned.

guitarmac1 commented 1 year ago

Hi @ziginfo I am trying to get the feedback happening in Touch-OSC but I am having the same issue getting feedback from Light hark to Touch-OSC. Touch-OSC to LightShark works fine I have made the send and receive ports the same as mentioned in your previous post.

Screenshot 2023-10-01 at 11 10 45 am Screenshot 2023-10-01 at 11 11 25 am
ziginfo commented 1 year ago

Hello as I said in my last message there was a little typing error in another message when I wrote : ""the Receive-Port on Touch-OSC must be the same as the Send-Port in Touch-OSC """..... but it should be : to receive the right button state, the Receive-Port on Touch-OSC must be the same as the Send-Port in LIGHTSHARK (!!) this works fine and I use it very often… sorry for this writing error

here is the thing step by step and you will see : it'll work fine !!! in the LightShark : set OSC-IN to 8000 and OSC-OUT to 9000 (these are the default-values ! but you can use other values if you like so ...) in Touch-OSC you have to do the opposite : OSC-IN must be 9000 and OSC-OUT should be 8000 => when Touch-OSC is talking on a given OSC-Port (=8000), and LightShark listens on that same port, than the dialogue is running !! and when LightShark sends back Data on his Out-Port (9000) , Touch-OSC should imperatively listen on that same port (9000)....

if the ports are NOT correctly configured, than the dialogue is interrupted and NOT running !! hope this clears up the whole thing !!! :)

also note the following if you set the same OUT and IN-Port on a given Software or gear, than the software is talking to itself (instead of talking to others)... which means : there is no more dialogue ! but just a monologue !!

guitarmac1 commented 1 year ago

Hi @ziginfo

Yes this is what I have tried but without any luck. Screen Shot 2023-10-02 at 3 16 22 pm

Screenshot 2023-10-02 at 3 15 24 pm
ziginfo commented 1 year ago

this is very strange.... but as OSC can only send to one single target... there might be also another conflict inside your tablet or your computer when the port 9000 is already in use by another program (... port 9000 is a very common used "default port" by many softwares !!)

you can try the following => just change the Output-Port in the LightShark (say 9003) and change also the Reveive-Port in Touch-OSC (same Port => so 9003 !)

you can try also the following... get Protokol (on the Website of Touch-OSC and its free) run Touch-OSC and run also Protocol... set any Send-Port in LightShark (say 9005); and set this same Port in Protokol !! do NOT set this same port in Touch-OSC; as this will create a conflict now when you hit the SYNC-Button on Touch-OSC, than LightShark will send the Datas back to Protokol instead of sending it to Touch_OSC... you will see if Data is sent or not !!

what Firmware do you use on the LightShark ?? you should use a 1.5...version ! latest is 1.5.13 !! good luck ! :)

guitarmac1 commented 1 year ago

Hi @ziginfo thank you again for this. I have updated the software of the light shark to 1.5.10 and it seems that Is has worked for the excectors. Now but not the faders. At least that which is the main thing. Will try and get version 1.5.13 from lightshark but not available to where I can see it. Thank you again.

ziginfo commented 1 year ago

hello guitarmac1 I don't know if you found a solution meanwhile... but here is another thought about this "bug" ... I just "repaired" a script for a friend who had this exactly same problem : no OSC-returns from Lightshark.... remember that the correct command is /LS/Sync followed by a Float 0 argument... the "bug" in my friends script was, that he wrote /LS/sync instead of /LS/Sync and it did not work !!

note also that : if OSC-return does not work for you with V1.5.10, it will not work either with V 1.5.13 you must understand that the problem is than not in LightShark but in your computer or your tablet or your scripting or your OSC configuration.... did you verify with Protokol (or any other OSC-Sniffer) that LightShark sends out any OSC-Data to its Output-Port ??

guitarmac1 commented 1 year ago

Hi @ziginfo You have been amazing and patient with me thank you. I have got it working with V1.5.10. But I think you are right there is a conflict on my end. I'll definitely get a copy of V1.5.13. as V1.5.10 has been ok. Also I have started testing the new light shark instance from @leonreucher He has been amazing!!!! pkg.tgz

ziginfo commented 1 year ago

Hello no worries for the help... (if it was helpful !? :) ) keep in mind, if you are a "current" LighShark user (for Shows, Events etc), there are some bugs in the 1.5.13 that are not present in the 1.5.10 (concerning for example the "V-Dimm" feature and the show-file handling etc... personally I downgraded back to 1.5.10 after having tested the latest Beta (and had some problems with...)

thanks for the hint about josephdadams Companion-Fork.... will give it a try.. :)

leonreucher commented 1 year ago

@guitarmac1 I think you meant me :) Since guitarmac1 shared the module here - please be aware that the module is not completely tested yet, and therefore not ready for production use. If you want to, please give the module a try and provide feedback on the Companion Slack channel :)

ziginfo commented 1 year ago

Hello Leonreucher and guitarmac I downloaded the new LightShark module ([pkg.tgz] with the new files.... but I don't know how to integrate it into the Companion... can you give me a hand, please ?? after than I can rapidly (and deeply) test it... thanks in advance and friendly greetings... :-)

leonreucher commented 1 year ago

@guitarmac1 can help you with that - he is a professional now regards adding dev modules ;)

josephdadams commented 1 year ago

I think we can all agree that I’m still amazing

leonreucher commented 1 year ago

No doubts on that!

guitarmac1 commented 1 year ago

@guitarmac1 I think you meant me :) Since guitarmac1 shared the module here - please be aware that the module is not completely tested yet, and therefore not ready for production use. If you want to, please give the module a try and provide feedback on the Companion Slack channel :)

I am so sorry @leonreucher! In my haste to reply I put in the wrong @. You are amazing good sir @leonreucher!!! I can't thank you enough. And you to @josephdadams hahahahaha.

guitarmac1 commented 1 year ago

@guitarmac1 can help you with that - he is a professional now regards adding dev modules ;)

I can help you with this no problem at all @ziginfo for you to in stall the new pkg

guitarmac1 commented 1 year ago

Hi @ziginfo this is what your file structure/directory should look like.

Screenshot 2023-10-17 at 6 57 14 am
guitarmac1 commented 1 year ago

Using companion version 3, you can just unzip this file. In the companion configuration window click on the settings button in the top right and select the path to the folder, where the extracted module folder is located (don’t point directly to the folder where the extracted files are, point to the folder above). E.g. C:/User/ABC/Desktop/module is the folder with the extracted files, the developer module path needs to be: C:/User/ABC/Desktop image

After this you should be able to add a new module in companion, called “LightShark: LS1”

ziginfo commented 1 year ago

hello leon and guitarmac thanks for your precious help... that works fine on Catalina and Companion V3 as my office Computer still runs Mojave (and sofor Companion V2) I did not see immediately how to integrate "developer modules ... (and I guess that "developer-modules" are not valid for Companion V2 ..?) thanks for all !! you're great

Leon, I tested quickly the features of your new file and all is running marvelous !! thanks a lot !! 👍 👍 just a couple of notes ... I would name the module LightShark-OSC (instead of lightshark) just to conform to the "official" name and maybe you can "integrate" into the file directly the Default IP address : 192.168.42.1 personally I am missing the three Sync commands ... /LS/Sync /LS/Sync/Playbacks /LS/Sync/Executors must been followed by a FLOAT argument 0.0

and in the attached file you can see some new OSC-command that have been added since the LightShark V1.5 versions

osc-commandes-new

leonreucher commented 1 year ago

Thank you for the image. I will implement missing functions.

The Sync commands are periodically run in the background - this is called polling. In the module configuration you can set the time, how often the Sync command should be sent. I could also implement, that polling can be disabled and that the Sync commands need to be sent manually - but I don't see the benefit here.

ziginfo commented 1 year ago

Hello Leon and a big thank for you 👍 👍 👍 unfortunately I have these new OSC command only as a screen-capture (pgn-file) as the official new PDF-Manual isn't published yet... but if you want I can rewrite them in text format for you... just tell me..

guitarmac1 commented 1 year ago

Thank you for the image. I will implement missing functions.

The Sync commands are periodically run in the background - this is called polling. In the module configuration you can set the time, how often the Sync command should be sent. I could also implement, that polling can be disabled and that the Sync commands need to be sent manually - but I don't see the benefit here.

If we are to have this as a "disable: function, Then as a default polling should always be on until the user disables this. but I do agree with @leonreucher if this is a benefit? However, @ziginfo if this is something that needs to be part of the instance and important then we should.

Screenshot 2023-10-17 at 9 37 09 pm
guitarmac1 commented 1 year ago

it is auto sync all, as I understand if I am not wrong?

leonreucher commented 1 year ago

pkg.tgz Not tested, but probably you could give the new actions a try. I guess there will be also some more feedbacks? Do you also have documentation on the new /LS/Sync command?

leonreucher commented 1 year ago

@guitarmac1 Yes, exactly. The /LS/Sync command is run every second in your example - and right after the response is received, the data will be parsed and the feedbacks will be refreshed.

ziginfo commented 1 year ago

Hello Leon everything works perfectly well; thank you sooo much for your excellent job !! its just marvelous !! thanks and have a nice day !! 👍

ziginfo commented 1 year ago

Hello Leon I finished testing all the functions deeply... you really made a great job; thank you very much... there is just one little bug; and it's about the preload/goto-Cue function... I guess you wanted to include a dropdown-menu with the choice of the two functions.... but the drop-down-menu does not work... the first function "goto Cue" (which is "default") runs fine and no problem... the second one (Preload) is just not available... may I suggest another little point ?? the Sub-Cue value has to be at least 10 !! so, a Sub-Cue as for example .6 does not work and is not recognized ! as it should be .60 a SubCue as .1 should be written and sent as .10 (LightShark works like that !) thanks and have a nice day.....

companion_capture

guitarmac1 commented 1 year ago

I agree @ziginfo @leonreucher has done an awesome job. Very impressed!

guitarmac1 commented 9 months ago

Hi @leonreucher I hope you have been well mate? Thank you so much again for coding Lightshark module. I think we can submit this to admin. I did mention in the slack chat that it would be nice to have some volume fuctions but that can be implemented at another revision.