diff --git a/CMakeLists.txt b/CMakeLists.txt index eb8d18575..c8b79b7cc 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -201,6 +201,7 @@ option(WITH_BRESSEREXOS2 "Install Bresser Exos 2 GoTo Mount Driver" On) option(WITH_PLAYERONE "Install Player One Astronomy's Camera Driver" On) option(WITH_WEEWX_JSON "Install Weewx JSON Driver" On) option(WITH_ROLLOFFINO "Install RollOff ino Dome Driver" On) +option(WITH_ASTROASIS "Install Astroasis Driver" On) # FFMPEG required for INDI Webcam driver find_package(FFmpeg) @@ -241,6 +242,7 @@ IF (${CMAKE_SYSTEM_NAME} MATCHES "Darwin") set(WITH_GPSD Off) set(WITH_AHP_XC Off) set(WITH_AHP_GT Off) + set(WITH_ASTROASIS Off) ENDIF () # Disable apogee, qhy and mi with gcc 4.8 and earlier versions IF (CMAKE_COMPILER_IS_GNUCXX AND CMAKE_CXX_COMPILER_VERSION VERSION_LESS 4.9) @@ -268,6 +270,7 @@ if (NO_PRE_BUILT) SET(WITH_SBIG Off) SET(WITH_SVBONY Off) SET(WITH_TOUPBASE Off) + SET(WITH_ASTROASIS Off) endif(NO_PRE_BUILT) # If the Build Libs option is selected, it will just build the required libraries. @@ -365,6 +368,11 @@ if (WITH_PLAYERONE) add_subdirectory(libplayerone) endif(WITH_PLAYERONE) +#libastroasis +if (WITH_ASTROASIS) +add_subdirectory(libastroasis) +endif(WITH_ASTROASIS) + # This is the main 3rd Party build. It runs if the Build Libs option is not selected. ELSE(BUILD_LIBS) @@ -750,6 +758,17 @@ if (WITH_NUT) add_subdirectory(indi-nut) endif() +# Astroasis +if (WITH_ASTROASIS) +find_package(ASTROASIS) +if (ASTROASIS_FOUND) +add_subdirectory(indi-astroasis) +else (ASTROASIS_FOUND) +add_subdirectory(libastroasis) +SET(LIBRARIES_FOUND FALSE) +endif(ASTROASIS_FOUND) +endif(WITH_ASTROASIS) + # Check if libraries are found. If not, we must build them, install them, THEN run CMake again to build and instal the drivers. If all the libraraies are installed, then we build and install the drivers only now. if (LIBRARIES_FOUND) message(STATUS "############################################################################") @@ -851,6 +870,10 @@ if (WITH_AHPGT AND NOT AHPGT_FOUND) message(STATUS "libahp-gt was not found and will now be built. Please install libahp-gt first before running cmake again to install indi-ahpgt.") endif (WITH_AHPGT AND NOT AHPGT_FOUND) +if (WITH_ASTROASIS AND NOT ASTROASIS_FOUND) +message(STATUS "libastroasis was not found and will now be built. Please install libastroasis first before running cmake again to install indi-astroasis.") +endif (WITH_ASTROASIS AND NOT ASTROASIS_FOUND) + message(STATUS "####################################################################################################################################") endif (LIBRARIES_FOUND) diff --git a/cmake_modules/FindASTROASIS.cmake b/cmake_modules/FindASTROASIS.cmake new file mode 100644 index 000000000..35f8c591d --- /dev/null +++ b/cmake_modules/FindASTROASIS.cmake @@ -0,0 +1,49 @@ +# - Try to find Astroasis Library +# Once done this will define +# +# ASTROASIS_FOUND - system has Astroasis +# ASTROASIS_INCLUDE_DIR - the Astroasis include directory +# ASTROASIS_LIBRARIES - Link these to use Astroasis + +# Redistribution and use is allowed according to the terms of the BSD license. +# For details see the accompanying COPYING-CMAKE-SCRIPTS file. + +if (ASTROASIS_INCLUDE_DIR AND ASTROASIS_LIBRARIES) + + # in cache already + set(ASTROASIS_FOUND TRUE) + message(STATUS "Found libastroasis: ${ASTROASIS_LIBRARIES}") + +else (ASTROASIS_INCLUDE_DIR AND ASTROASIS_LIBRARIES) + + find_path(ASTROASIS_INCLUDE_DIR AOFocus.h + PATH_SUFFIXES libastroasis + ${_obIncDir} + ${GNUWIN32_DIR}/include + ) + + find_library(ASTROASIS_LIBRARIES NAMES oasisfocuser + PATHS + ${_obLinkDir} + ${GNUWIN32_DIR}/lib + ) + + if(ASTROASIS_INCLUDE_DIR AND ASTROASIS_LIBRARIES) + set(ASTROASIS_FOUND TRUE) + else (ASTROASIS_INCLUDE_DIR AND ASTROASIS_LIBRARIES) + set(ASTROASIS_FOUND FALSE) + endif(ASTROASIS_INCLUDE_DIR AND ASTROASIS_LIBRARIES) + + if (ASTROASIS_FOUND) + if (NOT ASTROASIS_FIND_QUIETLY) + message(STATUS "Found Astroasis Library: ${ASTROASIS_LIBRARIES}") + endif (NOT ASTROASIS_FIND_QUIETLY) + else (ASTROASIS_FOUND) + if (ASTROASIS_FIND_REQUIRED) + message(FATAL_ERROR "Astroasis Library not found. Please install Astroasis Library http://www.indilib.org") + endif (ASTROASIS_FIND_REQUIRED) + endif (ASTROASIS_FOUND) + + mark_as_advanced(ASTROASIS_INCLUDE_DIR ASTROASIS_LIBRARIES) + +endif (ASTROASIS_INCLUDE_DIR AND ASTROASIS_LIBRARIES) diff --git a/indi-astroasis/CMakeLists.txt b/indi-astroasis/CMakeLists.txt new file mode 100644 index 000000000..66ef90ff3 --- /dev/null +++ b/indi-astroasis/CMakeLists.txt @@ -0,0 +1,47 @@ +cmake_minimum_required(VERSION 3.0) +PROJECT(indi_astroasis CXX C) + +LIST(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake_modules/") +LIST(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../cmake_modules/") +include(GNUInstallDirs) + +find_package(ASTROASIS REQUIRED) +find_package(CFITSIO REQUIRED) +find_package(INDI REQUIRED) +find_package(ZLIB REQUIRED) +find_package(USB1 REQUIRED) +find_package(Threads REQUIRED) + +set(ASTROASIS_VERSION_MAJOR 1) +set(ASTROASIS_VERSION_MINOR 0) + +set(INDI_DATA_DIR "${CMAKE_INSTALL_PREFIX}/share/indi") + +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/config.h.cmake ${CMAKE_CURRENT_BINARY_DIR}/config.h ) +configure_file(${CMAKE_CURRENT_SOURCE_DIR}/indi_astroasis.xml.cmake ${CMAKE_CURRENT_BINARY_DIR}/indi_astroasis.xml) + +include_directories( ${CMAKE_CURRENT_BINARY_DIR}) +include_directories( ${CMAKE_CURRENT_SOURCE_DIR}) +include_directories( ${INDI_INCLUDE_DIR}) +include_directories( ${CFITSIO_INCLUDE_DIR}) +include_directories( ${ASTROASIS_INCLUDE_DIR}) + +include(CMakeCommon) + +########### indi_oasis_focuser ########### +add_executable(indi_oasis_focuser ${CMAKE_CURRENT_SOURCE_DIR}/oasis_focuser.cpp) +IF (APPLE) +set(CMAKE_EXE_LINKER_FLAGS "-framework IOKit -framework CoreFoundation") +target_link_libraries(indi_oasis_focuser ${INDI_LIBRARIES} ${ASTROASIS_LIBRARIES} ${LIBUSB_LIBRARIES}) +ELSE() +target_link_libraries(indi_oasis_focuser ${INDI_LIBRARIES} ${ASTROASIS_LIBRARIES} ${USB1_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT}) +ENDIF() + +##################################### + +if (CMAKE_SYSTEM_PROCESSOR MATCHES "arm*") +target_link_libraries(indi_oasis_focuser rt) +endif (CMAKE_SYSTEM_PROCESSOR MATCHES "arm*") + +install(TARGETS indi_oasis_focuser RUNTIME DESTINATION bin) +install(FILES ${CMAKE_CURRENT_BINARY_DIR}/indi_astroasis.xml DESTINATION ${INDI_DATA_DIR}) diff --git a/indi-astroasis/COPYING.LGPL b/indi-astroasis/COPYING.LGPL new file mode 100644 index 000000000..4362b4915 --- /dev/null +++ b/indi-astroasis/COPYING.LGPL @@ -0,0 +1,502 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/indi-astroasis/INSTALL b/indi-astroasis/INSTALL new file mode 100644 index 000000000..272c1a309 --- /dev/null +++ b/indi-astroasis/INSTALL @@ -0,0 +1,16 @@ +Installation instructions +========================= + +Compile Instructions + - Assumption: INDI package installed (see https://indilib.org/download.html) + - Retrieve the sources for the Astroasis driver + git clone https://github.com/astroasis/indi-3rdparty.git + - cd indi-3rdparty + checkout branch "master" + - mkdir -p build/indi-astroasis + - cd build/indi-astroasis + - cmake -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug ../../indi-astroasis + - sudo make install + +And now start the INDI server and kstars. + diff --git a/indi-astroasis/README b/indi-astroasis/README new file mode 100644 index 000000000..e3d7585a8 --- /dev/null +++ b/indi-astroasis/README @@ -0,0 +1,7 @@ +Astroasis Oasis Focuser INDI Driver +By Frank Chen + +Description +INDI driver to control the Oasis Focuser. + +For installation instructions please follow the instructions from INSTALL. diff --git a/indi-astroasis/config.h.cmake b/indi-astroasis/config.h.cmake new file mode 100644 index 000000000..a8c56e892 --- /dev/null +++ b/indi-astroasis/config.h.cmake @@ -0,0 +1,10 @@ +#ifndef CONFIG_H +#define CONFIG_H + +/* Define INDI Data Dir */ +#cmakedefine INDI_DATA_DIR "@INDI_DATA_DIR@" +/* Define Driver version */ +#define ASTROASIS_VERSION_MAJOR @ASTROASIS_VERSION_MAJOR@ +#define ASTROASIS_VERSION_MINOR @ASTROASIS_VERSION_MINOR@ + +#endif // CONFIG_H diff --git a/indi-astroasis/indi-astroasis.spec b/indi-astroasis/indi-astroasis.spec new file mode 100644 index 000000000..1a1848b69 --- /dev/null +++ b/indi-astroasis/indi-astroasis.spec @@ -0,0 +1,78 @@ +%define __cmake_in_source_build %{_vpath_builddir} +Name: indi-astroasis +Version:2.0.2.git +Release: %(date -u +%%Y%%m%%d%%H%%M%%S)%{?dist} +Summary: Instrument Neutral Distributed Interface 3rd party drivers + +License: LGPLv2 +# See COPYRIGHT file for a description of the licenses and files covered + +URL: https://indilib.org +Source0: https://github.com/indilib/indi-3rdparty/archive/master.tar.gz + +BuildRequires: cmake +BuildRequires: libfli-devel +BuildRequires: libnova-devel +BuildRequires: qt5-qtbase-devel +BuildRequires: systemd +BuildRequires: gphoto2-devel +BuildRequires: LibRaw-devel +BuildRequires: indi-libs +BuildRequires: indi-devel +BuildRequires: libtiff-devel +BuildRequires: cfitsio-devel +BuildRequires: zlib-devel +BuildRequires: gsl-devel +BuildRequires: libcurl-devel +BuildRequires: libjpeg-turbo-devel +BuildRequires: fftw-devel +BuildRequires: libftdi-devel +BuildRequires: gpsd-devel +BuildRequires: libdc1394-devel +BuildRequires: boost-devel +BuildRequires: boost-regex + +BuildRequires: gmock + +BuildRequires: pkgconfig(fftw3) +BuildRequires: pkgconfig(cfitsio) +BuildRequires: pkgconfig(libcurl) +BuildRequires: pkgconfig(gsl) +BuildRequires: pkgconfig(libjpeg) +BuildRequires: pkgconfig(libusb-1.0) +BuildRequires: pkgconfig(zlib) + +Requires: libastroasis + +%description +INDI is a distributed control protocol designed to operate +astronomical instrumentation. INDI is small, flexible, easy to parse, +and scalable. It supports common DCS functions such as remote control, +data acquisition, monitoring, and a lot more. This is a 3rd party driver. + + +%prep -v +%autosetup -v -p1 -n indi-3rdparty-master + +%build +# This package tries to mix and match PIE and PIC which is wrong and will +# trigger link errors when LTO is enabled. +# Disable LTO +%define _lto_cflags %{nil} + +cd indi-astroasis +%cmake -DINDI_DATA_DIR=/usr/share/indi . +make VERBOSE=1 %{?_smp_mflags} -j4 + +%install +cd indi-astroasis +make DESTDIR=%{buildroot} install + +%files +%{_bindir}/* +%{_datadir}/indi + +%changelog +* Sun Jul 19 2020 Jim Howard 1.8.7.git-1 +- update to build from git for copr, credit to Sergio Pascual and Christian Dersch for prior work on spec files + diff --git a/indi-astroasis/indi_astroasis.xml.cmake b/indi-astroasis/indi_astroasis.xml.cmake new file mode 100644 index 000000000..908729be2 --- /dev/null +++ b/indi-astroasis/indi_astroasis.xml.cmake @@ -0,0 +1,9 @@ + + + + + indi_oasis_focuser + @ASTROASIS_VERSION_MAJOR@.@ASTROASIS_VERSION_MINOR@ + + + diff --git a/indi-astroasis/oasis_focuser.cpp b/indi-astroasis/oasis_focuser.cpp new file mode 100644 index 000000000..7e13a10cb --- /dev/null +++ b/indi-astroasis/oasis_focuser.cpp @@ -0,0 +1,480 @@ +/* + Astroasis Oasis Focuser + Copyright (C) 2013-2019 Jasem Mutlaq (mutlaqja@ikarustech.com) + Copyright (C) 2023 Frank Chen (frank.chen@astroasis.com) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + USA + +*/ + +#include "oasis_focuser.h" +#include "config.h" +#include "AOFocus.h" +#include "indicom.h" + +static class Loader +{ + std::deque> focusers; + public: + Loader() + { + focusers.push_back(std::unique_ptr(new OasisFocuser())); + } +} loader; + +OasisFocuser::OasisFocuser() +{ + setVersion(ASTROASIS_VERSION_MAJOR, ASTROASIS_VERSION_MINOR); + + FI::SetCapability(FOCUSER_CAN_ABS_MOVE | + FOCUSER_CAN_REL_MOVE | + FOCUSER_CAN_ABORT | + FOCUSER_CAN_REVERSE | + FOCUSER_CAN_SYNC | + FOCUSER_HAS_BACKLASH); + + // We use USB connection + setSupportedConnections(CONNECTION_NONE); +} + +bool OasisFocuser::initProperties() +{ + INDI::Focuser::initProperties(); + + // Focuser board temperature + TemperatureBoardNP[0].fill("TEMPERATURE", "Board", "%.2f", -100, 100, 0., 0.); + TemperatureBoardNP.fill(getDeviceName(), "FOCUS_TEMPERATURE_BOARD", "Temperature", + MAIN_CONTROL_TAB, IP_RO, 0, IPS_IDLE); + + // Focuser ambient temperature + TemperatureAmbientNP[0].fill("TEMPERATURE", "Ambient", "%.2f", -100, 100, 0., 0.); + TemperatureAmbientNP.fill(getDeviceName(), "FOCUS_TEMPERATURE_AMBIENT", "Temperature", + MAIN_CONTROL_TAB, IP_RO, 0, IPS_IDLE); + + // Backlash compensation direction + BacklashDirSP[INDI_ENABLED].fill("ON", "IN", ISS_ON); + BacklashDirSP[INDI_DISABLED].fill("OFF", "OUT", ISS_OFF); + BacklashDirSP.fill(getDeviceName(), "FOCUS_BACKLASH_DIRECTION", "Backlash Compensation Dir (Overshoot)", + MAIN_CONTROL_TAB, IP_RW, ISR_1OFMANY, 0, IPS_IDLE); + + // Focus motion beep + BeepOnMoveSP[INDI_ENABLED].fill("ON", "On", ISS_ON); + BeepOnMoveSP[INDI_DISABLED].fill("OFF", "Off", ISS_OFF); + BeepOnMoveSP.fill(getDeviceName(), "FOCUS_BEEP", "Beep", OPTIONS_TAB, IP_RW, ISR_1OFMANY, 0, IPS_IDLE); + + // Firmware version + VersionSP[0].fill("VERSION_FIRMWARE", "Firmware", "Unknown"); + VersionSP[1].fill("VERSION_SDK", "SDK", "Unknown"); + VersionSP.fill(getDeviceName(), "VERSION", "Version", INFO_TAB, IP_RO, 60, IPS_IDLE); + + FocusBacklashN[0].min = 0; + FocusBacklashN[0].max = 0x7fffffff; + FocusBacklashN[0].value = 0; + FocusBacklashN[0].step = 1; + + FocusRelPosN[0].min = 0.; + FocusRelPosN[0].max = 0x7fffffff; + FocusRelPosN[0].value = 0; + FocusRelPosN[0].step = 1; + + FocusAbsPosN[0].min = 0.; + FocusAbsPosN[0].max = 0x7fffffff; + FocusAbsPosN[0].value = 0; + FocusAbsPosN[0].step = 1; + + FocusMaxPosN[0].min = 0; + FocusMaxPosN[0].max = 0x7fffffff; + FocusMaxPosN[0].value = 0x7fffffff; + FocusMaxPosN[0].step = 1; + + setDefaultPollingPeriod(500); + addDebugControl(); + + return true; +} + +bool OasisFocuser::updateProperties() +{ + if (isConnected()) + { + GetConfig(); + GetStatus(); + + TemperatureBoardNP.setState(IPS_OK); + defineProperty(TemperatureBoardNP); + + TemperatureAmbientNP.setState(IPS_OK); + defineProperty(TemperatureAmbientNP); + + defineProperty(BacklashDirSP); + defineProperty(BeepOnMoveSP); + + // Update version info + AOFocuserVersion version; + char ver[100]; + + if (AOFocuserGetVersion(mID, &version) == AO_SUCCESS) + { + unsigned int firmware = version.firmware; + + snprintf(ver, sizeof(ver), "%d.%d.%d built %s", + firmware >> 24, (firmware >> 16) & 0xff, (firmware >> 8) & 0xff, version.built); + + VersionSP[0].setText(ver); + } + + AOFocuserGetSDKVersion(ver); + VersionSP[1].setText(ver); + + defineProperty(VersionSP); + + IDSetNumber(&FocusAbsPosNP, nullptr); + IDSetSwitch(&FocusReverseSP, nullptr); + IDSetNumber(&FocusBacklashNP, nullptr); + + LOG_INFO("Oasis Focuser parameters updated, focuser ready for use."); + + SetTimer(getCurrentPollingPeriod()); + } + else + { + deleteProperty(TemperatureBoardNP); + deleteProperty(TemperatureAmbientNP); + deleteProperty(BacklashDirSP); + deleteProperty(BeepOnMoveSP); + deleteProperty(VersionSP); + } + + return INDI::Focuser::updateProperties(); +} + +const char * OasisFocuser::getDefaultName() +{ + return "Oasis Focuser"; +} + +bool OasisFocuser::Connect() +{ + int number, ids[AO_FOCUSER_MAX_NUM]; + + AOFocuserScan(&number, ids); + + if (number <= 0) + return false; + + // For now we always use the first found Oasis Focuser + mID = ids[0]; + + return (AOFocuserOpen(mID) == AO_SUCCESS); +} + +bool OasisFocuser::Disconnect() +{ + AOFocuserClose(mID); + + return true; +} + +bool OasisFocuser::SetConfig(unsigned int mask, int value) +{ + AOFocuserConfig config; + + config.mask = mask; + + switch (mask) + { + case MASK_MAX_STEP: + config.maxStep = value; + break; + case MASK_BACKLASH: + config.backlash = value; + break; + case MASK_BACKLASH_DIRECTION: + config.backlashDirection = value; + break; + case MASK_REVERSE_DIRECTION: + config.reverseDirection = value; + break; + case MASK_SPEED: + config.speed = value; + break; + case MASK_BEEP_ON_MOVE: + config.beepOnMove = value; + break; + case MASK_BEEP_ON_STARTUP: + config.beepOnStartup = value; + break; + case MASK_BLUETOOTH: + config.bluetoothOn = value; + break; + default: + LOGF_ERROR("Invalid Oasis Focuser configuration mask %08X\n", mask); + return false; + } + + AOReturn ret = AOFocuserSetConfig(mID, &config); + + if (ret != AO_SUCCESS) + { + LOGF_ERROR("Failed to set Oasis Focuser configuration, ret = %d\n", ret); + return false; + } + + return true; +} + +bool OasisFocuser::GetConfig() +{ + AOFocuserConfig config; + + AOReturn ret = AOFocuserGetConfig(mID, &config); + + if (ret != AO_SUCCESS) + { + LOGF_ERROR("Failed to get oasis focuser configration, ret = %d\n", ret); + return false; + } + + // Update reverse settings + FocusReverseS[INDI_ENABLED].s = config.reverseDirection ? ISS_ON : ISS_OFF; + FocusReverseS[INDI_DISABLED].s = config.reverseDirection ? ISS_OFF : ISS_ON; + FocusReverseSP.s = IPS_OK; + + // Update max step + FocusAbsPosN[0].max = config.maxStep; + + // Update backlash + FocusBacklashN[0].value = config.backlash; + FocusBacklashNP.s = IPS_OK; + + // Update backlash compensation direction settings + BacklashDirSP[INDI_ENABLED].setState(config.backlashDirection ? ISS_OFF : ISS_ON); + BacklashDirSP[INDI_DISABLED].setState(config.reverseDirection ? ISS_ON : ISS_OFF); + BacklashDirSP.setState(IPS_OK); + + // Update beep settings + BeepOnMoveSP[INDI_ENABLED].setState(config.beepOnMove ? ISS_ON : ISS_OFF); + BeepOnMoveSP[INDI_DISABLED].setState(config.beepOnMove ? ISS_OFF : ISS_ON); + BeepOnMoveSP.setState(IPS_OK); + + return true; +} + +bool OasisFocuser::GetStatus() +{ + AOFocuserStatus status; + + AOReturn ret = AOFocuserGetStatus(mID, &status); + + if (ret != AO_SUCCESS) + { + LOGF_ERROR("Failed to get oasis focuser status, ret = %d\n", ret); + return false; + } + + FocusAbsPosN[0].value = status.position; + TemperatureBoardNP[0].setValue(status.temperatureInt / 100.0); + + if (!status.temperatureDetection || (status.temperatureExt == (int)TEMPERATURE_INVALID)) + TemperatureAmbientNP[0].setValue(-273.15); + else + TemperatureAmbientNP[0].setValue(status.temperatureExt / 100.0); + + return true; +} + +bool OasisFocuser::SetFocuserMaxPosition(uint32_t ticks) +{ + return SetConfig(MASK_MAX_STEP, ticks); +} + +bool OasisFocuser::SetFocuserBacklash(int32_t steps) +{ + return SetConfig(MASK_BACKLASH, steps); +} + +bool OasisFocuser::ReverseFocuser(bool enabled) +{ + return SetConfig(MASK_REVERSE_DIRECTION, enabled ? 1 : 0); +} + +bool OasisFocuser::isMoving() +{ + AOFocuserStatus status; + + AOReturn ret = AOFocuserGetStatus(mID, &status); + + if (ret != AO_SUCCESS) + { + LOGF_ERROR("Failed to get oasis focuser status, ret = %d\n", ret); + return false; + } + + return (status.moving != 0); +} + +bool OasisFocuser::SyncFocuser(uint32_t ticks) +{ + AOReturn ret = AOFocuserSyncPosition(mID, ticks); + + if (ret != AO_SUCCESS) + { + LOGF_ERROR("Failed to sync Oasis Focuser position, ret = %d\n", ret); + return false; + } + + return true; +} + +bool OasisFocuser::ISNewSwitch(const char * dev, const char * name, ISState * states, char * names[], int n) +{ + if (!dev || strcmp(dev, getDeviceName()) != 0) + { + return false; + } + + // Trun on/off beep + if (BeepOnMoveSP.isNameMatch(name)) + { + BeepOnMoveSP.update(states, names, n); + + int on = (BeepOnMoveSP.findOnSwitchIndex() == INDI_ENABLED) ? 1 : 0; + + if (SetConfig(MASK_BEEP_ON_MOVE, on)) + BeepOnMoveSP.setState(IPS_OK); + else + BeepOnMoveSP.setState(IPS_ALERT); + + BeepOnMoveSP.apply(); + + return true; + } + + // Set backlash compensation direction + if (BacklashDirSP.isNameMatch(name)) + { + BacklashDirSP.update(states, names, n); + + // 0 - IN, 1 - OUT + int dir = (BacklashDirSP.findOnSwitchIndex() == INDI_ENABLED) ? 0 : 1; + + if (SetConfig(MASK_BACKLASH_DIRECTION, dir)) + BacklashDirSP.setState(IPS_OK); + else + BacklashDirSP.setState(IPS_ALERT); + + BacklashDirSP.apply(); + + return true; + } + + return INDI::Focuser::ISNewSwitch(dev, name, states, names, n); +} + +bool OasisFocuser::ISNewNumber(const char * dev, const char * name, double values[], char * names[], int n) +{ + return INDI::Focuser::ISNewNumber(dev, name, values, names, n); +} + +IPState OasisFocuser::MoveAbsFocuser(uint32_t targetTicks) +{ + AOReturn ret = AOFocuserMoveTo(mID, targetTicks); + + if (ret != AO_SUCCESS) + { + LOGF_ERROR("MoveAbsFocuser() failed, ret = %d\n", ret); + return IPS_ALERT; + } + + return IPS_BUSY; +} + +IPState OasisFocuser::MoveRelFocuser(FocusDirection dir, uint32_t ticks) +{ + int32_t newPosition = 0; + + if (dir == FOCUS_INWARD) + newPosition = FocusAbsPosN[0].value - ticks; + else + newPosition = FocusAbsPosN[0].value + ticks; + + newPosition = std::max(0, std::min(static_cast(FocusAbsPosN[0].max), newPosition)); + + AOReturn ret = AOFocuserMoveTo(mID, newPosition); + + if (ret != AO_SUCCESS) + { + LOGF_ERROR("MoveRelFocuser() failed, ret = %d\n", ret); + return IPS_ALERT; + } + + FocusRelPosN[0].value = ticks; + FocusRelPosNP.s = IPS_BUSY; + + return IPS_BUSY; +} + +void OasisFocuser::TimerHit() +{ + if (!isConnected()) + { + SetTimer(getCurrentPollingPeriod()); + return; + } + + if (GetStatus()) + { + IDSetNumber(&FocusAbsPosNP, nullptr); + + if (TemperatureBoardNP.getState() != IPS_IDLE) + TemperatureBoardNP.apply(); + + if (TemperatureAmbientNP.getState() != IPS_IDLE) + TemperatureAmbientNP.apply(); + } + + if (FocusAbsPosNP.s == IPS_BUSY || FocusRelPosNP.s == IPS_BUSY) + { + if (!isMoving()) + { + FocusAbsPosNP.s = IPS_OK; + FocusRelPosNP.s = IPS_OK; + IDSetNumber(&FocusAbsPosNP, nullptr); + IDSetNumber(&FocusRelPosNP, nullptr); + LOG_INFO("Focuser reached requested position."); + } + } + + SetTimer(getCurrentPollingPeriod()); +} + +bool OasisFocuser::AbortFocuser() +{ + AOReturn ret = AOFocuserStopMove(mID); + + if (ret != AO_SUCCESS) + { + LOGF_ERROR("Failed to stop Oasis Focuser, ret = %d\n", ret); + return false; + } + + return true; +} + +bool OasisFocuser::saveConfigItems(FILE * fp) +{ + return INDI::Focuser::saveConfigItems(fp); +} diff --git a/indi-astroasis/oasis_focuser.h b/indi-astroasis/oasis_focuser.h new file mode 100644 index 000000000..7e9a580d5 --- /dev/null +++ b/indi-astroasis/oasis_focuser.h @@ -0,0 +1,96 @@ +/* + Astroasis Oasis Focuser + Copyright (C) 2013-2019 Jasem Mutlaq (mutlaqja@ikarustech.com) + Copyright (C) 2023 Frank Chen (frank.chen@astroasis.com) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 + USA + +*/ + +#pragma once + +#include "indifocuser.h" + +class OasisFocuser : public INDI::Focuser +{ + public: + OasisFocuser(); + virtual ~OasisFocuser() override = default; + + const char * getDefaultName() override; + virtual bool initProperties() override; + virtual bool updateProperties() override; + virtual bool ISNewSwitch(const char * dev, const char * name, ISState * states, char * names[], int n) override; + virtual bool ISNewNumber(const char * dev, const char * name, double values[], char * names[], int n) override; + + protected: + virtual bool Connect() override; + virtual bool Disconnect() override; + + /** + * @brief MoveAbsFocuser Move to an absolute target position + * @param targetTicks target position + * @return IPS_BUSY if motion is in progress. IPS_OK if motion is small and already complete. IPS_ALERT for trouble. + */ + virtual IPState MoveAbsFocuser(uint32_t targetTicks) override; + + /** + * @brief MoveRelFocuser Move focuser for a relative amount of ticks in a specific direction + * @param dir Directoin of motion + * @param ticks steps to move + * @return IPS_BUSY if motion is in progress. IPS_OK if motion is small and already complete. IPS_ALERT for trouble. + */ + virtual IPState MoveRelFocuser(FocusDirection dir, uint32_t ticks) override; + + /** + * @brief SyncFocuser Set the supplied position as the current focuser position + * @param ticks target position + * @return IPS_OK if focuser position is now set to ticks. IPS_ALERT for problems. + */ + virtual bool SyncFocuser(uint32_t ticks) override; + + virtual bool ReverseFocuser(bool enabled) override; + virtual bool SetFocuserMaxPosition(uint32_t ticks) override; + virtual bool SetFocuserBacklash(int32_t steps) override; + virtual bool AbortFocuser() override; + virtual void TimerHit() override; + virtual bool saveConfigItems(FILE *fp) override; + + private: + uint8_t mID; + + bool SetConfig(unsigned int mask, int value); + bool GetConfig(); + bool GetStatus(); + + // Are we moving? + bool isMoving(); + + // Read Only Board Temperature Reporting + INDI::PropertyNumber TemperatureBoardNP{1}; + + // Read Only Ambient Temperature Reporting + INDI::PropertyNumber TemperatureAmbientNP{1}; + + // Backlash compensation direction (overshoot method) + INDI::PropertySwitch BacklashDirSP{2}; + + // Beep on move setting + INDI::PropertySwitch BeepOnMoveSP{2}; + + // Firmware and SDK versions + INDI::PropertyText VersionSP{2}; +}; diff --git a/libastroasis/99-astroasis.rules b/libastroasis/99-astroasis.rules new file mode 100644 index 000000000..496ce9856 --- /dev/null +++ b/libastroasis/99-astroasis.rules @@ -0,0 +1,2 @@ +# Astroasis devices +SUBSYSTEMS=="usb", ATTR{idVendor}=="0x338f", MODE="0666" diff --git a/libastroasis/AOFocus.h b/libastroasis/AOFocus.h new file mode 100644 index 000000000..5d6e875ca --- /dev/null +++ b/libastroasis/AOFocus.h @@ -0,0 +1,181 @@ +/* + * Copyright 2023 Suzhou Astroasis Vision Technology, Inc. All Rights Reserved. + * + * This is header file for Astroasis Oasis Focuser. + * + * Note: + * 1. AOFocuserScan() should be called before any other APIs (except for + * AOFocuserGetSDKVersion()) for at least one time because those APIs require + * focuser ID as their first parameter. + * 2. AOFocuserScan() can be called for multiple times at any time as long as + * the user wants to refresh focusers. + * 3. AOFocuserGetSDKVersion() can be called at anytime and any place. + * 4. The buffer length for names (including product model, serial number, + * friendly name, Bluetooth name) should not less than AO_FOCUSER_NAME_LEN. + * 5. The list of API functions are as follows. + * AOFocuserScan(int *number, int *ids); + * AOFocuserOpen(int id); + * AOFocuserClose(int id); + * AOFocuserGetProductModel(int id, char *model); + * AOFocuserGetVersion(int id, AOFocuserVersion *version); + * AOFocuserGetSerialNumber(int id, char *sn); + * AOFocuserGetFriendlyName(int id, char *name); + * AOFocuserSetFriendlyName(int id, char *name); + * AOFocuserGetBluetoothName(int id, char *name); + * AOFocuserSetBluetoothName(int id, char *name); + * AOFocuserGetConfig(int id, AOFocuserConfig *config); + * AOFocuserSetConfig(int id, AOFocuserConfig *config); + * AOFocuserGetStatus(int id, AOFocuserStatus *status); + * AOFocuserFactoryReset(int id); + * AOFocuserSetZeroPosition(int id); + * AOFocuserMove(int id, int step); + * AOFocuserMoveTo(int id, int position); + * AOFocuserStopMove(int id); + * AOFocuserFirmwareUpgrade(int id, unsigned char *data, int len); + * AOFocuserGetSDKVersion(char *version); + * + * Refer to SDK demo application for the details of the API usage. + */ + +#ifndef __AOFOCUS_H__ +#define __AOFOCUS_H__ + +#ifdef __cplusplus +extern "C" { +#endif + +#ifdef _WINDOWS +#define AOAPI __declspec(dllexport) +#else +#define AOAPI +#endif + +#define AO_FOCUSER_MAX_NUM 32 /* Maximum focuser numbers supported by this SDK */ +#define AO_FOCUSER_VERSION_LEN 32 /* Buffer length for version strings */ +#define AO_FOCUSER_NAME_LEN 32 /* Buffer length for name strings */ + +#define TEMPERATURE_INVALID 0x80000000 /* This value indicates the invalid value of ambient temperature */ + +typedef enum _AOReturn { + AO_SUCCESS = 0, /* Success */ + AO_ERROR_INVALID_ID, /* Device ID is invalid */ + AO_ERROR_INVALID_PARAMETER, /* One or more parameters are invalid */ + AO_ERROR_INVALID_STATE, /* Device is not in correct state for specific API call */ + AO_ERROR_BUFFER_TOO_SMALL, /* Size of buffer is too small */ + AO_ERROR_COMMUNICATION, /* Data communication error such as device has been removed from USB port */ + AO_ERROR_TIMEOUT, /* Timeout occured */ + AO_ERROR_BUSY, /* Device is being used by another application */ + AO_ERROR_NULL_POINTER, /* Caller passes null-pointer parameter which is not expected */ + AO_ERROR_OUT_OF_RESOURCE, /* Out of resouce such as lack of memory */ + AO_ERROR_NOT_IMPLEMENTED, /* The interface is not currently supported */ + AO_ERROR_FAULT, /* Significant fault which means the device may not work correctly and hard to recovery it */ + AO_ERROR_INVALID_SIZE, /* Size is invalid */ + AO_ERROR_INVALID_VERSION, /* Version is invalid */ + AO_ERROR_UNKNOWN = 0x40, /* Any other errors */ +} AOReturn; + +/* + * Used by AOFocuserSetConfig() to indicates which field wants to be set + */ +#define MASK_MAX_STEP 0x00000001 +#define MASK_BACKLASH 0x00000002 +#define MASK_BACKLASH_DIRECTION 0x00000004 +#define MASK_REVERSE_DIRECTION 0x00000008 +#define MASK_SPEED 0x00000010 +#define MASK_BEEP_ON_MOVE 0x00000020 +#define MASK_BEEP_ON_STARTUP 0x00000040 +#define MASK_BLUETOOTH 0x00000080 +#define MASK_ALL 0xFFFFFFFF + +typedef struct _AOFocuserVersion +{ + unsigned int protocal; /* Version of protocal over USB and Bluetooth communication */ + unsigned int hardware; /* Focuser hardware version */ + unsigned int firmware; /* Focuser firmware version */ + char built[24]; /* Null-terminated string which indicates firmware building time */ +} AOFocuserVersion; + +typedef struct _AOFocuserConfig { + unsigned int mask; /* Used by AOFocuserSetConfig() to indicates which field wants to be set */ + int maxStep; /* Maximum step or position */ + int backlash; /* Backlash value */ + int backlashDirection; /* Backlash direction. 0 - IN, others - OUT */ + int reverseDirection; /* 0 - Not reverse motor moving direction, others - Reverse motor moving direction */ + int speed; /* Reserved for motor speed setting. Should always be zero for now */ + int beepOnMove; /* 0 - Turn off beep for move, others - Turn on beep for move */ + int beepOnStartup; /* 0 - Turn off beep for device startup, others - Turn on beep for device startup */ + int bluetoothOn; /* 0 - Turn off Bluetooth, others - Turn on Bluetooth */ +} AOFocuserConfig; + +/* + * Note: + * temperatureExt is valid only when temperatureDetection is not zero and + * temperatureExt is not equal to TEMPERATURE_INVALID + */ +typedef struct _AOFocuserStatus { + int temperatureInt; /* Internal (on board) temperature in 0.01 degree unit */ + int temperatureExt; /* External (ambient) temperature in 0.01 degree unit */ + int temperatureDetection; /* 0 - ambient temperature probe is not inserted, others - ambient temperature probe is inserted */ + int position; /* Current motor position */ + int moving; /* 0 - Motor is not moving, others - Motor is moving */ +} AOFocuserStatus; + +/* + * API: AOFocuserScan + * + * Description + * Scan for connected focusers. + * + * Parameters + * number: + * Pointer to an int value to hold the number of connected focusers. + * ids: + * Pointer to an int array to hold IDs of connected focusers. + * The length of the 'ids' array should be equal to or larger than + * AO_FOCUSER_MAX_NUM, and it's the caller's responsibility to allocate + * memory for "ids" before the API is called. + * The valid IDs are stored in first "number" of elements in "ids" array. + * + * Return value + * AO_SUCCESS: + * The function succeeds. This is the only value the API returns. + * + * Remarks + * This function should be called before any other APIs except for + * AOCameraGetSDKVersion(). + * Each focuser has a unique ID. If one focuser is removed from USB port + * and then plugged in again, it will be considered as different focuser + * and will be assigned with different ID during next scan. If one focuser + * remains connected during two or more scan operations, it will always + * have the same ID to indicate it's the same focuser. That is, the caller + * can call AOFocuserScan() at any time and the IDs of connected focusers + * returned by previous AOFocuserScan() will still be valid. + */ +AOAPI AOReturn AOFocuserScan(int *number, int *ids); +AOAPI AOReturn AOFocuserOpen(int id); +AOAPI AOReturn AOFocuserClose(int id); +AOAPI AOReturn AOFocuserGetProductModel(int id, char *model); +AOAPI AOReturn AOFocuserGetVersion(int id, AOFocuserVersion *version); +AOAPI AOReturn AOFocuserGetSerialNumber(int id, char *sn); +AOAPI AOReturn AOFocuserGetFriendlyName(int id, char *name); +AOAPI AOReturn AOFocuserSetFriendlyName(int id, char *name); +AOAPI AOReturn AOFocuserGetBluetoothName(int id, char *name); +AOAPI AOReturn AOFocuserSetBluetoothName(int id, char *name); +AOAPI AOReturn AOFocuserGetConfig(int id, AOFocuserConfig *config); +AOAPI AOReturn AOFocuserSetConfig(int id, AOFocuserConfig *config); +AOAPI AOReturn AOFocuserGetStatus(int id, AOFocuserStatus *status); +AOAPI AOReturn AOFocuserFactoryReset(int id); +AOAPI AOReturn AOFocuserSetZeroPosition(int id); +AOAPI AOReturn AOFocuserSyncPosition(int id, int position); +AOAPI AOReturn AOFocuserMove(int id, int step); +AOAPI AOReturn AOFocuserMoveTo(int id, int position); +AOAPI AOReturn AOFocuserStopMove(int id); +AOAPI AOReturn AOFocuserUpgrade(int id); +AOAPI AOReturn AOFocuserFirmwareUpgrade(int id, unsigned char *data, int len); +AOAPI AOReturn AOFocuserGetSDKVersion(char *version); + +#ifdef __cplusplus +} +#endif + +#endif /* __AOFOCUS_H__ */ diff --git a/libastroasis/CMakeLists.txt b/libastroasis/CMakeLists.txt new file mode 100644 index 000000000..811e0997c --- /dev/null +++ b/libastroasis/CMakeLists.txt @@ -0,0 +1,46 @@ +cmake_minimum_required (VERSION 3.0) +project (libastroasis) + +set (OASISFOCUSER_VERSION "1.0.5") +set (OASISFOCUSER_SOVERSION "1") + +list (APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake_modules/") +list (APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../cmake_modules/") +include (GNUInstallDirs) +include (InstallImported) + +add_library (oasisfocuser SHARED IMPORTED) + +set_target_properties (oasisfocuser PROPERTIES VERSION ${OASISFOCUSER_VERSION} SOVERSION ${OASISFOCUSER_SOVERSION}) + +if (APPLE) + + set_property (TARGET oasisfocuser PROPERTY IMPORTED_LOCATION "mac/liboasisfocuser.bin") + + FIX_MACOS_LIBRARIES("liboasisfocuser" "mac/liboasisfocuser.bin" "ASTROASIS") + + # Install library + install_imported (TARGETS oasisfocuser DESTINATION ${CMAKE_INSTALL_LIBDIR}) + +elseif (UNIX AND NOT WIN32) + if (CMAKE_SYSTEM_PROCESSOR MATCHES "armv+") + set_property (TARGET oasisfocuser PROPERTY IMPORTED_LOCATION "armhf/liboasisfocuser.bin") + elseif (CMAKE_SYSTEM_PROCESSOR MATCHES "aarch64") + set_property (TARGET oasisfocuser PROPERTY IMPORTED_LOCATION "arm64/liboasisfocuser.bin") + elseif (CMAKE_SIZEOF_VOID_P MATCHES "8") + set_property (TARGET oasisfocuser PROPERTY IMPORTED_LOCATION "x64/liboasisfocuser.bin") + else () + message (FATAL_ERROR "x86-32 architecture is not supported.") + endif () + + # Install udev rules + set (UDEVRULES_INSTALL_DIR "/lib/udev/rules.d" CACHE STRING "Base directory for udev rules") + install (FILES 99-astroasis.rules DESTINATION ${UDEVRULES_INSTALL_DIR}) + + # Install library + install_imported (TARGETS oasisfocuser DESTINATION ${CMAKE_INSTALL_LIBDIR}) + +endif () + +# Install header files +install (FILES AOFocus.h DESTINATION include/libastroasis) diff --git a/libastroasis/arm64/liboasisfocuser.bin b/libastroasis/arm64/liboasisfocuser.bin new file mode 100755 index 000000000..82027cdb9 Binary files /dev/null and b/libastroasis/arm64/liboasisfocuser.bin differ diff --git a/libastroasis/armhf/liboasisfocuser.bin b/libastroasis/armhf/liboasisfocuser.bin new file mode 100755 index 000000000..116eb525b Binary files /dev/null and b/libastroasis/armhf/liboasisfocuser.bin differ diff --git a/libastroasis/libastroasis.spec b/libastroasis/libastroasis.spec new file mode 100644 index 000000000..787e55cc3 --- /dev/null +++ b/libastroasis/libastroasis.spec @@ -0,0 +1,84 @@ +%define __cmake_in_source_build %{_vpath_builddir} +Name: libastroasis +Version:2.0.2.git +Release: %(date -u +%%Y%%m%%d%%H%%M%%S)%{?dist} +Summary: Instrument Neutral Distributed Interface 3rd party drivers + +License: LGPLv2 +# See COPYRIGHT file for a description of the licenses and files covered + +URL: https://indilib.org +Source0: https://github.com/indilib/indi-3rdparty/archive/master.tar.gz + +%global debug_package %{nil} +%define __find_requires %{nil} + +BuildRequires: cmake +BuildRequires: libfli-devel +BuildRequires: libnova-devel +BuildRequires: qt5-qtbase-devel +BuildRequires: systemd +BuildRequires: gphoto2-devel +BuildRequires: LibRaw-devel +BuildRequires: indi-libs +BuildRequires: indi-devel +BuildRequires: libtiff-devel +BuildRequires: cfitsio-devel +BuildRequires: zlib-devel +BuildRequires: gsl-devel +BuildRequires: libcurl-devel +BuildRequires: libjpeg-turbo-devel +BuildRequires: fftw-devel +BuildRequires: libftdi-devel +BuildRequires: gpsd-devel +BuildRequires: libdc1394-devel +BuildRequires: boost-devel +BuildRequires: boost-regex + +BuildRequires: gmock + +BuildRequires: pkgconfig(fftw3) +BuildRequires: pkgconfig(cfitsio) +BuildRequires: pkgconfig(libcurl) +BuildRequires: pkgconfig(gsl) +BuildRequires: pkgconfig(libjpeg) +BuildRequires: pkgconfig(libusb-1.0) +BuildRequires: pkgconfig(zlib) + +Provides: liboasisfocuser.so()(64bit) +Provides: liboasisfocuser.so + +%description +INDI is a distributed control protocol designed to operate +astronomical instrumentation. INDI is small, flexible, easy to parse, +and scalable. It supports common DCS functions such as remote control, +data acquisition, monitoring, and a lot more. This is a 3rd party driver. + + +%prep -v +%autosetup -v -p1 -n indi-3rdparty-master + +%build +# This package tries to mix and match PIE and PIC which is wrong and will +# trigger link errors when LTO is enabled. +# Disable LTO +%define _lto_cflags %{nil} + +cd libastroasis +%cmake . +make VERBOSE=1 %{?_smp_mflags} -j4 + +%install +cd libastroasis +find %buildroot -type f \( -name '*.so' -o -name '*.so.*' \) -exec chmod 755 {} + +make DESTDIR=%{buildroot} install + +%files +%{_libdir}/* +%{_includedir}/libastroasis +/lib/udev/rules.d/99-astroasis.rules + +%changelog +* Mon Jul 27 2020 Jim Howard 1.8.7.git-1 +- update to build from git for copr, credit to Sergio Pascual and Christian Dersch for prior work on spec files + diff --git a/libastroasis/x64/liboasisfocuser.bin b/libastroasis/x64/liboasisfocuser.bin new file mode 100644 index 000000000..8d3c15134 Binary files /dev/null and b/libastroasis/x64/liboasisfocuser.bin differ